Skip to content

Commit

Permalink
Merge pull request #7101 from birkskyum/update-custom-bundle
Browse files Browse the repository at this point in the history
Elaborate on custom bundle instructions
  • Loading branch information
archmoj authored Aug 13, 2024
2 parents cc7f9f9 + 3d4cfe9 commit 74dedd4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
25 changes: 22 additions & 3 deletions CUSTOM_BUNDLE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
# Custom bundle
You can simply make custom bundles yourself, if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or you want to make a more optimized bundle file with/without specific traces and transforms.

Install plotly.js, move to plotly.js folder then install plotly.js dependencies:
Make sure you have the versions of node/npm that's recommended:
- plotly.js before 2.5: Node 12/npm 6
- plotly.js from 2.5: Node 16/npm 8
- plotly.js from 2.35: Node 18/npm 10

To download a specific node version look [here](https://nodejs.org/en/download/package-manager).

Note: For CI, it's faster to do `git clone --depth 1` to only get one commit.

Clone plotly.js, where the <version> is one of [these](https://github.com/plotly/plotly.js/tags):
```sh
git clone --branch <version> https://github.com/plotly/plotly.js.git
```

Note: If you've already cloned plotly.js, then could switch to another version with:
```sh
git fetch
git checkout <version>
```

Move to plotly.js folder then install plotly.js dependencies:
```sh
npm i plotly.js
cd node_modules/plotly.js
cd plotly.js
npm i
```

Expand Down
2 changes: 2 additions & 0 deletions draftlogs/7101_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Elaborate on the Custom Bundle guide [[#7101](https://github.com/plotly/plotly.js/pull/7101)]

0 comments on commit 74dedd4

Please sign in to comment.