Skip to content

[plotly.js] add docs about non-browserify workflows in getting-started page #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
etpinard opened this issue Dec 1, 2015 · 8 comments
Closed
Assignees

Comments

@etpinard
Copy link
Contributor

etpinard commented Dec 1, 2015

@mdtusz @chriddyp @jackparmer @bpostlethwaite @cldougl

Quite a bit of folks have been complaining about plotly.js 's npm-browserify-centric view of the world:

plotly/plotly.js#13
plotly/plotly.js#22

I would be nice to make the plotly.js getting started page (page | source) show how plotly.js works with workflows.

Moreover, we should write a section about how to plotly.js users can build their own bundle e.g. a bundle with d3 removed using browserify -x.

@bpostlethwaite
Copy link
Member

Agreed, @mdtusz sounds like a good issue for you to tackle. It will intro you to our existing documentation and build tooling. Want to work with @etpinard and @cldougl on this?

@mdtusz mdtusz self-assigned this Dec 1, 2015
@chriddyp
Copy link
Member

chriddyp commented Dec 1, 2015

@etpinard
Copy link
Contributor Author

etpinard commented Dec 3, 2015

@mdtusz We should also document this plotly/plotly.js#39 in the getting started

When using the un-minified dist/plotly.js, you must include charset="utf-8" in the script tag.

@mdtusz
Copy link
Contributor

mdtusz commented Dec 3, 2015

Will do. We can also add a webpack field in the package.json so that users don't have to require('plotly.js/dist/plotly.min.js') and can just require('plotly.js').

@etpinard
Copy link
Contributor Author

etpinard commented Dec 3, 2015

@mdtusz +1 for the webpack field.

@mdtusz
Copy link
Contributor

mdtusz commented Dec 3, 2015

Should all work now for webpack users. It's not a beautiful unicorn fix, but it works and will let them get plotting.

@bpostlethwaite
Copy link
Member

@mdtusz, this one in the bag then?

@bpostlethwaite
Copy link
Member

ah saw the note about holding till the next release! disregard :)

@mdtusz mdtusz closed this as completed Dec 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants