Create an article about `docs as code`

[sentenz]

Docs as Code

Technical documentation as Docs as Code refers to a philosophy where documents are treated as code with issue tracking, version control (Git), code reviews, and automated testing.

Docs as Code enables a culture where authors and developers take ownership of documentation.

Markup

Markup language refers to a text-encoding system consisting of a set of symbols inserted in a text document to control its structure, formatting, or the relationship between its parts.

Markdown

Markdown (md) is a plain text format for writing structured documents, based on formatting conventions from email and usenet. Developed in 2004 by John Gruber in collaboration with Aaron Swartz.

Hugo is a popular Markdown framework for static site generator (SSG).

AsciiDoc

AsciiDoc (adoc) is a plain text markup language for writing technical content. It is packed with semantic elements and equipped with features to modularize and reuse content. AsciiDoc content can be composed using a text editor, managed in a version control system, and published to multiple output formats.

The Asciidoc framework Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model. Asciidoctor converts plain text formats into HTML 5, DocBook 5, manual pages, PDF, and EPUB 3.

reStructuredText

reStructuredText (rst) is a plain text markup syntax and parser system, primary defined and implement as a markup syntax for use in Python docstrings. reStructuredText is a revision and reinterpretation of the Setext lightweight markup systems, the reStructuredText parser is a component of Docutils.

Sphinx is a framework for reStructuredText originally created for Python documentation. Sphinx transforms reStructuredText plain-text files format into HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, and manual pages.

UML

The Unified Modeling Language (UML) is a universal development modeling language intended to visualize the design of a system.

Mermaid

Mermaid is a diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.

PlantUML

PlantUML generate UML diagram from textual description.

See also

• GitHub markdown guide.
• Jekyll web docs article.
• docToolchain docs article.
• arc42 docs article.

[github-actions[bot]]

:tada: This issue has been resolved in version 1.12.0 :tada:

The release is available on:

• GitHub release
• v1.12.0

Your semantic-release bot :package::rocket: