Skip to content

Commit

Permalink
Docs: add asciidoc example (#10759)
Browse files Browse the repository at this point in the history
add asciidoc example
  • Loading branch information
oraNod authored Sep 20, 2023
1 parent c7e7722 commit 3c27c71
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/user/build-customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -463,3 +463,23 @@ These projects can be built using a configuration file like this:
commands:
- mkdir --parents $READTHEDOCS_OUTPUT/html/
- cp --recursive docs/* $READTHEDOCS_OUTPUT/html/
Asciidoc
^^^^^^^^

`Asciidoctor <https://asciidoctor.org/>`__ is a fast processor for converting and generating documentation from AsciiDoc source.
The Asciidoctor toolchain includes `Asciidoctor.js <https://docs.asciidoctor.org/asciidoctor.js/latest/>`__ which you can use with custom build commands.
Here is an example configuration file:

.. code-block:: yaml
:caption: .readthedocs.yaml
version: 2
build:
os: "ubuntu-22.04"
tools:
nodejs: "20"
commands:
- npm i -g asciidoctor
- asciidoctor index.asciidoc
- mkdir -pv $READTHEDOCS_OUTPUT/html/ && mv index.html $READTHEDOCS_OUTPUT/html/

0 comments on commit 3c27c71

Please sign in to comment.