search

OAI / learn.openapis.org

OpenAPI - Getting started, and the specification explained
https://learn.openapis.org/
Creative Commons Attribution 4.0 International
120 stars 60 forks source link

The OpenAPI Specification Explained page has two Table of Contents #15

Closed segfaultxavi closed 1 year ago

segfaultxavi commented 4 years ago

I guess because has_children == true a TOC is automatically added by the theme, but it already has one, and it's more detailed. The automatic TOC should be removed.

mniinio commented 3 years ago

I removed the automatic TOC, but it removes it also from the side navigation. Also, it's not best practice to maintain a manual toc, since the links get broken really easily or a page gets missing...

segfaultxavi commented 3 years ago

Unfortunately, I don't think dropping this whole section from the TOC is acceptable. I like the manual TOC because it contains more information than just the page titles. In this case, it shows which keywords are discussed in each page, which I think is pretty useful. Isn't there a way to have the TOC appear on the sidebar but hide it from the page? In Sphinx I do that by marking the toc as :hidden: but I don't know about github pages.

segfaultxavi commented 3 years ago

Answering my own question, apparently adding toc: false to the frontmatter should do the trick. I haven't checked, though.