Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nice doc with Nav :) #148

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Nice doc with Nav :) #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion docs/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
* xref:index.adoc[Quarkus Renarde]
include::./includes/attributes.adoc[]
:config-file: application.properties

* xref:index.adoc[Getting started]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we generate this TOC? It's bound to be forgotten/out of sync, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gastaldi ? Could generate it from the == of all the pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be fine as H2 titles don't change everyday, but better have it generated if possible yeah

Copy link
Member

@gastaldi gastaldi Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe there is an Asciidoc macro or something that will generate the TOC based on the file. I know there is this: https://docs.asciidoctor.org/asciidoc/latest/toc/ but it doesn't seem to work for XREF links

* xref:concepts.adoc[Main Concepts]
** xref:concepts.adoc#models[Models]
** xref:concepts.adoc#controllers[Controllers]
** xref:concepts.adoc#views[Views]
* xref:advanced.adoc[Advanced Guides]
** xref:advanced.adoc#forms[Forms]
** xref:advanced.adoc#routing[Routing]
** xref:advanced.adoc#emails[Emails]
** xref:advanced.adoc#localisation[Localisation / Internationalisation]
** xref:advanced.adoc#flash_scope[Flash Scope]
** xref:advanced.adoc#htmx[htmx]
** xref:advanced.adoc#generating_barcodes[Generating barcodes]
** xref:advanced.adoc#generating_pdf_documents[Generating PDF]
* xref:security.adoc[Security]
** xref:security.adoc#csrf[CSRF]
** xref:security.adoc#custom_authentication_with_jwt[Custom Auth (JWT)]
** xref:security.adoc#oidc[OIDC]
* xref:config-reference.adoc[Config Reference]

Loading