mkdocs-render-swagger-plugin icon indicating copy to clipboard operation
mkdocs-render-swagger-plugin copied to clipboard

Table of Contents (TOC)

Open luispsantos opened this issue 1 year ago • 2 comments

Hello, thank you for the effort that went into creating this project. I was wondering if it would be possible to add support for rendering a table of contents (TOC) of the API endpoints on the right of the page, which is a feature I am used to in MkDocs.

luispsantos avatar Oct 07 '23 12:10 luispsantos

Is it a feature bundled in swagger? Otherwise it will require custom coding, which I will require help at :-)

On Sat, Oct 7, 2023, 2:00 PM Luis Santos @.***> wrote:

Hello, thank you for the effort that went into creating this project. I was wondering if it would be possible to add support for rendering a table of contents (TOC) of the API endpoints on the right of the page, which is a feature I am used to in MkDocs.

— Reply to this email directly, view it on GitHub https://github.com/bharel/mkdocs-render-swagger-plugin/issues/29, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFVHV6TEFNW4P2NKJTMCU3X6FG5RAVCNFSM6AAAAAA5W5KOROVHI2DSMVQWIX3LMV43ASLTON2WKOZRHEZTCMZUGMZTANQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

bharel avatar Oct 07 '23 15:10 bharel

It is not a feature bundled in Swagger but I've seen it on other similar tools. For example this one for MkDocs will generate a Table of Contents on the right side. Probably out of scope, but Redoc for NodeJS also generates a navigatable TOC.

luispsantos avatar Oct 09 '23 03:10 luispsantos