Skip to content
This repository was archived by the owner on Mar 25, 2018. It is now read-only.
This repository was archived by the owner on Mar 25, 2018. It is now read-only.

Doctool: Remark plugins #61

Description

@chrisdickinson

This is a tracking issue for a new doctool using 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

  • @include syntax (remark-include by @Qard)
  • Hook into Node Makefile
  • YAML frontmatter (for stability index)
    • per-section YAML
  • {Type} parsing (for parity with this PR)
  • Basic layout selection (for switching between guides and API layouts)
  • Header anchors

Nice to have

  • Linting
    • ESLint for JS code examples
    • Link validation
    • 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      Sponsor
      SponsoredKunjungi sekarang
      Promo