Repository navigation
Ship manpages for all core modules #8903
Description
It would be super neat if all the Node core modules shipped manpages. E.g. the HTTP module would have a corresponding node-http(3) manpage. (Is section 3 the most appropriate? It's for library calls, so I'm not sure. Let's bikeshed.) In particular this is useful for working offline - I suspect a lot of distributions of Node don't ship the HTML docs. I know my Homebrew install sure didn't install them.
I'm totally willing to put together a PR adding a build process for these, but I wanted to double-check that such a PR would be accepted.
Activity
Fishrock123 commentedon Oct 3, 2016
I'd be ok with this but I'm not sure what the maintenance burden would be like.
If the doctool could build it I'd be down though. (Specifically, the library pages, I'd prefer the
node.1page to remain as it is I think.)Section 3 sounds about right.
strugee commentedon Oct 3, 2016
That's what I was planning to do. We can just automatically build them from Markdown.
addaleax commentedon Oct 4, 2016
Btw, would it help if we switched from marked to remark? I think it has become clear in the past that that might make sense, and re-writing the doctool with that has been on my long-term todo list.
strugee commentedon Oct 4, 2016
For some reason I thought it was already on remark? But yeah, if not I'd do that too.
Trott commentedon Jul 10, 2017
@nodejs/documentation Thoughts on this one?
strugee commentedon Jul 11, 2017
FYI I started a PR for this today in #14164.
Trott commentedon Jun 13, 2018
It seems like perhaps this should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. I'm just tidying up and not acting on a super-strong opinion or anything like that.