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

Jump to bottom

Fix broken links to extension api documentation #523

Merged
merged 2 commits into from
Apr 9, 2021
Merged

Fix broken links to extension api documentation #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9619b1
Fix broken links to extension api documentation
djarnis73 Apr 7, 2021
756d076
Update changelog
djarnis73 Apr 8, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Documentation::
* Migrate docs (README) to Antora site and publish them in gh-pages (#498)
* Remove ambiguity in usage of maven properties docs (#507)
* Add ID to 'attributes' description, to be able to generate direct url from other docs (#509)
* Fix broken links to extension api documentation (#523).

Maintenance::

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/plugin/partials/process-asciidoc-mojo-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ include::partial$setting-boolean-attributes.adoc[]
embedAssets:: embeds the CSS file and images into the output, defaults to `false`
gemPaths:: enables to specify the location to one or more gem installation directories (same as GEM_PATH environment var), `empty` by default
requires:: a `List<String>` to specify additional Ruby libraries not packaged in AsciidoctorJ, `empty` by default
extensions:: `List` of extensions to include during the conversion process (see link:https://github.com/asciidoctor/asciidoctorj/blob/master/docs/integrator-guide.adoc#automatically-loading-extensions[AsciidoctorJ's Extension API] for information about the available options).
extensions:: `List` of extensions to include during the conversion process (see link:https://docs.asciidoctor.org/asciidoctorj/latest/extensions/extensions-introduction/[AsciidoctorJ's Extension API] for information about the available options).
For each extension, the implementation class must be specified in the `className` parameter, the `blockName` is only required when configuring a _BlockProcessor_, _BlockMacroProcessor_ or _InlineMacroProcessor_.
+
[source,xml]
Expand Down Expand Up @@ -148,7 +148,7 @@ For each extension, the implementation class must be specified in the `className
<1> Extensions must be included in the plugin's execution classpath, not in the project's.
+
NOTE: Extensions can also be integrated through the SPI interface implementation.
This method does not require any configuration in the [.path]_pom.xml_, see link:https://github.com/asciidoctor/asciidoctorj/blob/master/docs/integrator-guide.adoc#automatically-loading-extensions[Automatically loading extensions] for details.
This method does not require any configuration in the [.path]_pom.xml_, see link:https://docs.asciidoctor.org/asciidoctorj/latest/extensions/register-extensions-automatically/[Automatically loading extensions] for details.

enableVerbose:: enables Asciidoctor verbose messages, defaults to `false`.
Enable it, for example, if you want to validate https://asciidoctor.org/docs/user-manual/#validating-internal-cross-references[internal cross references] and capture the messages with the logHandler option.
Expand Down