This is a tracking issue for a new doctool using [remark](http://npm.im/remark). The goals are: - Render the **api** docs as HTML roughly equivalent to the existing doctool output. - Render the **guides** and **tutorials** added to the nodejs/node repo as HTML. This issue will contain all known breakages and necessary plugins (both existing and net new), broken into "required" and "nice to have": ## Required - [x] `@include` syntax ([`remark-include`](https://www.npmjs.com/package/remark-include) by @qard) - [ ] Hook into Node `Makefile` - [ ] YAML frontmatter (for stability index) - [ ] per-section YAML - [ ] `{Type}` parsing (for parity with [this PR](https://github.com/nodejs/node/pull/4741)) - [ ] Basic layout selection (for switching between guides and API layouts) - [ ] [Header anchors](https://www.npmjs.com/package/remark-slug) ## Nice to have - [ ] Linting - [x] ESLint for JS code examples - [ ] [Link validation](https://www.npmjs.com/package/remark-validate-links) - [ ] API Method format validator - [ ] Make existing docs pass lint - [ ] Hook into Node `Makefile` tests - [ ] API headers — check to make sure they're in alphabetical order - [ ] Switch table of contents generation to [remark-toc](https://www.npmjs.com/package/remark-toc)
This is a tracking issue for a new doctool using remark. The goals are:
This issue will contain all known breakages and necessary plugins (both existing and net new), broken into "required" and "nice to have":
Required
@includesyntax (remark-includeby @Qard)Makefile{Type}parsing (for parity with this PR)Nice to have
Makefiletests