OpenAPI docs - Table of Contents?

[wadewilliams]

In this screenshot, you can see a table of contents displayed on the right of the page.

This doesn't seem to be the current behavior. Is this possibly a regression or is there some specific option that needs to be set in order for it to work properly?

My markdown file has no contents besides the tag for [OAD("./docs/swagger-config.json")]

[JegDudley]

I have the same question.

Any help would be appreciated, Neoteroi! 😀 Thanks

[JegDudley]

@wadewilliams - I was able to get the table of contents working by building my docs using @RobertoPrevato/ Neoterio's essentials-openapi, instead of mkdocs-plugins.

I followed the instructions here: https://github.com/Neoteroi/essentials-openapi

and built them to markdown output format.

[nsheff]

In my hands the TOC only shows up if the file lacks a top-level header.

So, this shows NO TOC:

# title

[OAD(./docs/specification.yaml)]

this file does show the TOC:

[OAD(./docs/specification.yaml)]

It would be nice to be able to embed the docs into an existing structure, and still include it in the TOC, like:

# Spec

## Introduction

blah blah blah

## Formal spec

[OAD(./docs/specification.yaml)]

This will show only the 'introduction' in the TOC,

It would be nice if you could include a top-level header apart from the auto-rendered openapi docs.