Offline documentation (html or pdf), possible?

81 views
Skip to first unread message

Harry

unread,
Mar 25, 2016, 12:04:45 AM3/25/16
to nodejs
Hello,

Can the full html or pdf documentation be provided with every stable Node release for offline viewing?

I can save the 'all.html' page from the browser but the index on the side (that lets me jump straight a section) continues to have online links in it. I cannot use wget -r either as not sure to what folder level I should descend.

Regards,
/HS

Matt

unread,
Mar 25, 2016, 7:34:26 PM3/25/16
to nod...@googlegroups.com
I'd love it so much much if Node shipped with man pages, so I could type "man node-fs" to get the fs man page. But I'm pretty sure I'd have to submit the pull request to make that happen :)

--
Job board: http://jobs.nodejs.org/
New group rules: https://gist.github.com/othiym23/9886289#file-moderation-policy-md
Old group rules: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines
---
You received this message because you are subscribed to the Google Groups "nodejs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to nodejs+un...@googlegroups.com.
To post to this group, send email to nod...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/nodejs/7b20daec-a03f-4aca-92d9-a07b7f0a261f%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

William Kapke

unread,
Mar 25, 2016, 7:34:31 PM3/25/16
to nodejs
Try opening a feature request (via Github's issue tracker) at https://github.com/nodejs/docs/issues. They are a very active Working Group!

Good luck!

Ben Noordhuis

unread,
Mar 25, 2016, 7:34:34 PM3/25/16
to nod...@googlegroups.com
If you download a source tarball from https://nodejs.org/dist/, it has
the documentation in markdown format in the doc/api directory. You
can convert it to HTML with `make doc`, it will put it in out/doc.

Harry

unread,
Mar 26, 2016, 12:18:35 AM3/26/16
to nodejs
Tried this tarball,
    https://nodejs.org/dist/latest-v5.x/node-v5.9.1-linux-x64.tar.xz

but could not find any doc/api directory in it.

There are .md files such as:
      node-v5.9.1-linux-x64/lib/node_modules/npm/doc/cli/npm-bugs.md

Jérémy Lal

unread,
Mar 26, 2016, 12:18:46 AM3/26/16
to nodejs
```
marked-man fs.markdown > fs.1
man ./fs.1
```
and the result is not so bad :)

Ben Noordhuis

unread,
Mar 26, 2016, 3:03:27 PM3/26/16
to nod...@googlegroups.com
On Sat, Mar 26, 2016 at 4:53 AM, Harry <simon...@gmail.com> wrote:
> Tried this tarball,
> https://nodejs.org/dist/latest-v5.x/node-v5.9.1-linux-x64.tar.xz
>
> but could not find any doc/api directory in it.
>
> There are .md files such as:
> node-v5.9.1-linux-x64/lib/node_modules/npm/doc/cli/npm-bugs.md

That's a binaries-only tarball. You need a source tarball so the one
you want in this case is
https://nodejs.org/dist/v5.9.1/node-v5.9.1.tar.xz.

Александр М.

unread,
Mar 26, 2016, 3:03:28 PM3/26/16
to nodejs

суббота, 26 марта 2016 г., 8:18:35 UTC+4 пользователь Harry написал:
Tried this tarball,
    https://nodejs.org/dist/latest-v5.x/node-v5.9.1-linux-x64.tar.xz
but could not find any doc/api directory in it.

This is Linux binaries, not source code.
Source code - https://nodejs.org/dist/v5.9.1/node-v5.9.1.tar.gz
Documentation index ./node-v5.9.1/doc/api/index.html

Harry

unread,
Mar 28, 2016, 1:42:11 PM3/28/16
to nodejs
(Ouch!)

Thank you, folks.


On Sunday, March 27, 2016 at 12:33:27 AM UTC+5:30, Ben Noordhuis wrote:
That's a binaries-only tarball.  You need a source tarball so the one
you want in this case is
https://nodejs.org/dist/v5.9.1/node-v5.9.1.tar.xz.

Reply all
Reply to author
Forward
0 new messages