swagger.io
swagger.io copied to clipboard
Swagger Tools and Integrations could do with a Table of Contense
I was thinking that the Tools and Intergrations page could do with a table of contense.
I looked into making a pull request on the markdown file, but I don't know how it's being intergrated into wordpress.
I think this would also be hugely benifical for the specification page.
It's frustrating to:
- Not have a table of contense
- Not be able to link directly to a section of the page.
Github adds links to every header tag. Would this be something that could be added automatically to the spec and other pages on the Swagger site?
Thanks for the feedback.
I can point you to the right page if you'd like to submit a PR, but before you do, can you maybe give me a run down of what you'd want to see there (just a rough outline)? I'm not sure what you'd want to see in the ToC.
As for the second issue regarding the linking, I completely agree and we need to find a generic way to solve it - it bothers me quite a bit in other pages as well. Would you mind opening a specific issue on that so we won't forget to handle it?
Hey! I'd love to make a RP if I can find time to do so!
I'd expect a ToC to be just that. A list of any H tags, probably levels 1-3. I'm assuming headings have been used correctly though. It would just help to understand what's there without having to trawl the whole page.
Re linking issue. The simplest way I see this being done currently is how github does it. If you look at any of the markdown documents, you'll be able to get a link for any header.
I think both issue could be resolved similatiously. For example by using https://github.com/renettarenula/anchorific.js (although it's noted that the linked example site is offline). That project actually explains what I'd like to see.