Skip to content

Commit

Permalink
Antora docs improvements (#723)
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsromero committed Mar 12, 2024
1 parent 75b9168 commit 4d67801
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ asciidoc:
asciidoctor-maven-plugin-name: Asciidoctor Maven Plugin
asciidoctor-maven-plugin-url: https://github.com/asciidoctor/asciidoctor-maven-plugin
asciidoctor-url: https://asciidoctor.org
asciidoctorj-epub-name: Asciidoctorj EPUB3
asciidoctorj-epub-name: AsciidoctorJ EPUB3
asciidoctorj-epub-url: https://github.com/asciidoctor/asciidoctorj-epub3
asciidoctorj-name: AsciidoctorJ
asciidoctorj-pdf-name: Asciidoctorj PDF
asciidoctorj-pdf-name: AsciidoctorJ PDF
asciidoctorj-pdf-url: https://github.com/asciidoctor/asciidoctorj-pdf
asciidoctorj-url: https://github.com/asciidoctor/asciidoctorj
asciidoctorjs-name: Asciidoctor.js
Expand Down
17 changes: 8 additions & 9 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
* xref:index.adoc[]
* xref:compatibility.adoc[]
* xref:quick-start.adoc[]
* xref:common-task-configuration.adoc[]
* xref:asciidoctorj-base-plugin.adoc[]
* xref:asciidoctorj-plugin.adoc[]
* xref:asciidoctorj-pdf-plugin.adoc[]
* xref:asciidoctorj-epub-plugin.adoc[]
* xref:asciidoctorj-revealjs-plugin.adoc[]
* Plugins
** xref:asciidoctorj-base-plugin.adoc[]
** xref:asciidoctorj-plugin.adoc[]
** xref:asciidoctorj-pdf-plugin.adoc[]
** xref:asciidoctorj-epub-plugin.adoc[]
** xref:asciidoctorj-revealjs-plugin.adoc[]
** xref:asciidoctorj-gems-plugin.adoc[]
** xref:asciidoctoreditorconfig-plugin.adoc[]
// * xref:asciidoctorj-leanpub-plugin.adoc[]
* xref:asciidoctorj-gems-plugin.adoc[]
* xref:asciidoctor-diagram.adoc[]
// * xref:kindlegen-plugin.adoc[]
* xref:asciidoctorj-custom-extensions.adoc[]
* xref:asciidoctorjs-plugin.adoc[]
* xref:asciidoctoreditorconfig-plugin.adoc[]
* xref:docinfo.adoc[]
* xref:upgrading.adoc[]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= The Asciidoctor Editor Config Plugin
= Asciidoctor Editor Config Plugin

[source,groovy,role="primary"]
[subs=attributes+]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/asciidoctorj-base-plugin.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= AsciidoctorJ Base Plugin

This plugin is automatically applied by all AsciidoctorJ-based plugins.
This plugin is automatically applied by all {asciidoctorj-name}-based plugins.

Adds an extension for configuring which version of {asciidoctorj-name} and various other {asciidoctorj-name} backends.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/compatibility.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Compatibility

This collection of plugins requires at least Gradle 4.9, JDK 11.0 and AsciidoctorJ 2.0.0 to run.
This collection of plugins requires at least Gradle 4.9, JDK 11.0 and {asciidoctorj-name} 2.0.0 to run.
If you need prior Gradle, JDK or {asciidoctorj-name} support please use a plugin from the 1.5.x or 1.6.x release series.
1 change: 1 addition & 0 deletions docs/modules/appendices/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* Appendices
** xref:asciidoctorjs-plugin.adoc[]
** xref:tips-and-tricks.adoc[]
** xref:known-limitations.adoc[]
** xref:hacking.adoc[]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Working with Asciidoctor.js instead
= Working with Asciidoctor.js

Instead of {asciidoctorj-name}, {asciidoctorjs-url}[{asciidoctorjs-name}] can be used as a rendering engine from 3.0.

Expand Down

0 comments on commit 4d67801

Please sign in to comment.