Skip to content

Commit

Permalink
Update docs to graduate parser-doxia-module to Beta (#962)
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsromero authored Oct 30, 2024
1 parent 138897c commit 451a3eb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ First, all of your AsciiDoc-based files should be placed in [.path]_src/site/asc
These files will be converted into the [.path]_target/site_ directory.
For example, the file [.path]_src/site/asciidoc/usage.adoc_ will be converted into [.path]_target/site/usage.html_.

NOTE: Since `maven-site-plugin` v3.20.0, paths apply a default locale configuration.
If locale is not set, sources must be places in [.path]_src/site/*en*/asciidoc/_.

Then, all resources (images, css, etc.) should be placed in [.path]_src/site/resources_.
These will be automatically copied into [.path]_target/site_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:doxia-module-name: asciidoctor-parser-doxia-module
:fluido-skin-url: https://maven.apache.org/skins/maven-fluido-skin/

WARNING: This module is still considered experimental and early stages.
WARNING: This module is considered in _Beta_, available for general use covering most AsciiDoc features.
Please, consider sharing feedback and reporting any issue you find, or improvement you consider to help us improve.

This module uses Asciidoctor to parse AsciiDoc source files and then uses a custom converter adapted to Maven Site styles.
Expand Down Expand Up @@ -44,6 +44,9 @@ First, all of your AsciiDoc-based files should be placed in [.path]_src/site/asc
These files will be converted into the [.path]_target/site_ directory.
For example, the file [.path]_src/site/asciidoc/usage.adoc_ will be converted into [.path]_target/site/usage.html_.

NOTE: Since `maven-site-plugin` v3.20.0, paths apply a default locale configuration.
If locale is not set, sources must be places in [.path]_src/site/*en*/asciidoc/_.

Then, all resources (images, css, etc.) should be placed in [.path]_src/site/resources_.
These will be automatically copied into [.path]_target/site_.

Expand Down

0 comments on commit 451a3eb

Please sign in to comment.