Skip to content
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

feature: view core modules documentation #4

Open
tillre opened this issue May 29, 2012 · 3 comments
Open

feature: view core modules documentation #4

tillre opened this issue May 29, 2012 · 3 comments

Comments

@tillre
Copy link

tillre commented May 29, 2012

No description provided.

@rf
Copy link
Owner

rf commented May 30, 2012

There's actually this: https://github.com/trentm/nodedoc which does just that, but imo a more permanent solution is needed.

I definitely do want to do this. The problem is: node doesn't drop the markdown files anywhere when make installed (and even if it did, I can't rely on package maintainers leaving them where they are). So, I have to find a way to obtain the documentation for the version of node the user is running.

@rf
Copy link
Owner

rf commented May 30, 2012

I wrote a really simple implementation that just pulls the docs from node's master branch using raw.github.com, but I'm going to keep this ticket open while looking for a better solution.

@StreetStrider
Copy link
Contributor

nodedoc scares me, since it's not an actual JS package, it's a python package where npm is used as a transport. The utility is good, though, but it would be better to have similar utility in JS world, written in JS.

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

3 participants