Skip to content

Generate TOCs for specification docs #464

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

Closed
wants to merge 1 commit into from

Conversation

scottydawg
Copy link

This change adds a gulp task for generating a variant of the markdown specification with a table of contents (using the DocToc library).

The swagger specification document is a bit unwieldy as a reference point because:

  • It has no ToC to provide a high-level context of what is contained in the specification, and
  • The styles used on http://swagger.io/specification/ visually deemphasize h4 elements; h5 elements are more pronounced. This makes the hierarchy difficult to navigate.

This change doesn't address styling issues on swagger.io, but does allow generation the specification document with a ToC.

@ePaul
Copy link
Contributor

ePaul commented Apr 19, 2016

Could you rebase your Pull request against current master (or maybe even better, current OpenAPI.next)? There the specs are in the versions folder.

@webron
Copy link
Member

webron commented Apr 19, 2016

We can consider this for 3.0, but we shouldn't make the changes to 1.2 and 2.0.

@webron
Copy link
Member

webron commented May 20, 2016

Closing as we'll be introducing only must-have updates to the specs (typos or 'bug' fixes).

@webron webron closed this May 20, 2016
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

Successfully merging this pull request may close these issues.

3 participants