Nice doc with Nav :) #148
Nice doc with Nav :) #148
Conversation
ia3andy
force-pushed
the
doc
branch
2 times, most recently
from
190f751 to
d3eb7a9
Compare
| include::./includes/attributes.adoc[] | ||
| :config-file: application.properties | ||
|
|
||
| * xref:index.adoc[Getting started] |
There was a problem hiding this comment.
Can't we generate this TOC? It's bound to be forgotten/out of sync, no?
There was a problem hiding this comment.
@gastaldi ? Could generate it from the == of all the pages?
There was a problem hiding this comment.
I think it should be fine as H2 titles don't change everyday, but better have it generated if possible yeah
There was a problem hiding this comment.
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
I:
|
|
Why manual fragments instead of the auto-generated ones? |
So they don't change if the title changes as they are referenced |
|
OK, very good point :) |
|
@FroMage did you approve? |
|
(we can always switch to auto-generated if that become something) |
|
To test the nav locally I think you'd need to run Antora to generate the website by changing the Antora playbook to point to your repository/branch |
Actually it's worse than this. Now my generated How do I test my docs locally now? |
I thought I broke something but yeah I think we need to have some nav generated locally It seems to be nice: |
|
Yeah, it looks nice, on the surface, BUT… now I have two navs: one at the left which is missing deeper levels and is not generated, and one at the right which is missing higher levels but is generated. This is really bad UI. How can we fix this? |
|
Yeah, I agree. We should somehow adapt the local generation to use Antora and its layout (as it's built in quarkiverse-docs) |
|
I don't think it's BAD UI, people tend to see things differently. Still I think we should have a common experience, let's continue the discussion there where @holly-cummins has already started some comparison with other docs: |
|
@gastaldi for some reason the config reference is not working, I think it wasn't already before my change any thoughts? |
|
@ia3andy I browsed the sources and didn't find any interface with |
|
I seem to have also lost the favicon I recently added :( |
Inspired by other extensions like:
@gastaldi I didn't find a way to test the nav locally