Skip to content

Commit 3c27c71

Browse files
authored
Docs: add asciidoc example (#10759)
add asciidoc example
1 parent c7e7722 commit 3c27c71

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/user/build-customization.rst

+20
Original file line numberDiff line numberDiff line change
@@ -463,3 +463,23 @@ These projects can be built using a configuration file like this:
463463
commands:
464464
- mkdir --parents $READTHEDOCS_OUTPUT/html/
465465
- cp --recursive docs/* $READTHEDOCS_OUTPUT/html/
466+
467+
Asciidoc
468+
^^^^^^^^
469+
470+
`Asciidoctor <https://asciidoctor.org/>`__ is a fast processor for converting and generating documentation from AsciiDoc source.
471+
The Asciidoctor toolchain includes `Asciidoctor.js <https://docs.asciidoctor.org/asciidoctor.js/latest/>`__ which you can use with custom build commands.
472+
Here is an example configuration file:
473+
474+
.. code-block:: yaml
475+
:caption: .readthedocs.yaml
476+
477+
version: 2
478+
build:
479+
os: "ubuntu-22.04"
480+
tools:
481+
nodejs: "20"
482+
commands:
483+
- npm i -g asciidoctor
484+
- asciidoctor index.asciidoc
485+
- mkdir -pv $READTHEDOCS_OUTPUT/html/ && mv index.html $READTHEDOCS_OUTPUT/html/

0 commit comments

Comments
 (0)