top | item 38504820

(no title)

splittingTimes | 2 years ago

For writing documentation: AsciiDoc [1] as fileformat.

For publishing documentation / to build the web site: Antora [2].

AsciiDoc has a bit more features compared to Markdown which allows for a richer and more pleasant presentation of the docs.

Antora allows you to have the project documentation in the actual project repositories. It then pulls the docs from all the different repos together to build the site. This also allows you to have the released product versions go in-synch with the docs versions. Antora builds each version of the product as part of one site. The reader can explore different product versions or navigate between pages across versions.

===

[1] https://asciidoc.org/

[2] https://antora.org/

discuss

order

euroderf|2 years ago

When I read about the "Docs as Code" approach, I never see mention of Antora. Is this an oversight ?