101 add antora file structure requirements#102
Conversation
Signed-off-by: Bill Traynor wmat@riscv.org
Signed-off-by: Bill Traynor wmat@riscv.org
Signed-off-by: Bill Traynor wmat@riscv.org
| number = {6}, | ||
| pages = {1688-1698}, | ||
| month = {December} | ||
| } |
There was a problem hiding this comment.
You should add the @ misc example and info about using it rather than @ electric
| @@ -0,0 +1,2 @@ | |||
| [index] | |||
| == Index | |||
There was a problem hiding this comment.
Add the rest of the page, including the riscv image, title, and then what to put on the front page.
| @@ -0,0 +1,78 @@ | |||
| = RISC-V Example Specification Document (Zexmpl) | |||
There was a problem hiding this comment.
we don't use this in antora? do we need both? Is this just to build the PDF? and if so, does this mean that we aren't going to use the antora pdf generator?
There was a problem hiding this comment.
if this file is there and isn't included in the nav file, antora kicks up an error about orphan files.
| ==== | ||
|
|
||
| [preface] | ||
| == Copyright and license information |
There was a problem hiding this comment.
Split this out into a new page for antora. All the rest are set up like this
| // https://docs.antora.org/antora/latest/navigation/ | ||
| // | ||
| // Update this file to reflect your specification's chapter structure. | ||
|
|
There was a problem hiding this comment.
this needs a title - the nav title which is sometimes shorter than the full spec title.
.title
| // Update this file to reflect your specification's chapter structure. | ||
|
|
||
| * xref:spec-sample.adoc[RISC-V Example Specification] | ||
| ** xref:intro.adoc[Introduction] |
There was a problem hiding this comment.
most of the nav files use a flat structure? So they are all just a single *
|
|
||
| ui: | ||
| bundle: | ||
| url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip |
There was a problem hiding this comment.
this UI bundle was unfound? Maybe https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable is what I found.
2 participants
Updates for Antora