Navigating between multiple documentation files

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Navigating between multiple documentation files

fprochazka
Hi,
I'm using Spring REST Docs and since we have a big API, we have the documentation split to several files and the root index.adoc links to all of them. This works great!

But, once you're at one of the sections, for example user/index.html, there is no easy way to navigate back to "homepage".

Adding a "back to homepage" link above the TOC would be enough for me, but I haven't found any way to customize the layout of the pages to add such link.

Thanks you
Ted
Reply | Threaded
Open this post in threaded view
|

Re: Navigating between multiple documentation files

Ted
fprochazka wrote
But, once you're at one of the sections, for example user/index.html, there is no easy way to navigate back to "homepage".

Adding a "back to homepage" link above the TOC would be enough for me, but I haven't found any way to customize the layout of the pages to add such link.

You can create a custom Slim template to add a link back to your home page. Here are some instructions https://github.com/tedbergeron/AsciidoctorCustomTemplate

Or just add a link on your user/index.adoc and other pages back to the home page

link:../index.adoc[Home Page]

or even add an icon

link:../index.adoc[icon:home[] Home Page]
- Ted @TedAtCIS