Convert to asciidoc, integrate with Antora #63
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add the README.adoc, coming from pandoc, title levels manually adapted manually fix the lists that were destroyed during the conversion Adding some spaces before the lists, as specified in the documentation https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/, Try making Antora work without defining modules directory and corresponding structure Respect standard directory structure Update the index.adoc according to the new modifications done in README.md Include an Antora playbook to generate a standalone version of the documentation for this project, replace the README.md by a very short README.adoc with a link to the published doc on github pages, Add a github action to build and publish with Antora Ignore build directory created by local run of Antora, Correct link to published website Add information about the way to document and what structure to follow to organize the content Add metadata Merge modifications from #56b7fcd8087fd852cf299520ceca7037e7fd993b Authors on one line add remark, remove unused variable declaration Build new Documentation page only when merging to master
acampergue-camptocamp
force-pushed
the
convert_to_asciidoc
branch
from
b419db8
to
35dc120
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Converted the README.md into a very small README.adoc, linking to the Antora's version of the doc published on github pages via actions.
The original documentation is now in the docs/modules/ROOT/pages/index.adoc file, and is just a "converted" version of the README.md