-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
<!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11947.org.readthedocs.build/en/11947/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11947.org.readthedocs.build/en/11947/ <!-- readthedocs-preview dev end -->
- Loading branch information
1 parent
5b03ee1
commit 582823d
Showing
3 changed files
with
64 additions
and
3 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
Antora | ||
====== | ||
|
||
.. meta:: | ||
:description lang=en: Hosting Antora documentation on Read the Docs. | ||
|
||
`Antora`_ is a static site generator for creating documentation sites from AsciiDoc content. | ||
|
||
Minimal configuration is required to build an existing Antora project on Read the Docs. | ||
|
||
.. code-block:: yaml | ||
:caption: .readthedocs.yaml | ||
version: 2 | ||
build: | ||
os: ubuntu-lts-latest | ||
tools: | ||
nodejs: latest | ||
jobs: | ||
install: | ||
- npm i -g @antora/[email protected] @antora/[email protected] | ||
build: | ||
html: | ||
- antora --fetch antora-playbook.yml --to-dir $READTHEDOCS_OUTPUT/html | ||
.. _Antora: https://antora.org/ | ||
|
||
Getting Started | ||
--------------- | ||
|
||
- If you have an existing Antora project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide. | ||
- If you're new to Antora, check out the official `Getting Started with Antora`_ guide. | ||
|
||
.. _Getting Started with Antora: https://docs.antora.org/antora/latest/install-and-run-quickstart/ | ||
|
||
Example Repository and Demo | ||
--------------------------- | ||
|
||
Example repository | ||
https://github.com/readthedocs/test-builds/tree/antora | ||
|
||
Demo | ||
https://test-builds.readthedocs.io/en/antora/ | ||
|
||
Further Reading | ||
--------------- | ||
|
||
* `Antora documentation`_ | ||
|
||
.. _Antora documentation: https://docs.antora.org/antora/latest/ |
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