Markup-to-doc converter

A mark-up-to-doc converter or static document generator is software that generates a document from a markup language text.

Markup-to-doc tools:

  • Document converter
  • Documentation generator
  • Static code generator
  • Publishing system

List of document converters

Markup-to-doc converters featured on this post:

  • Pandoc
  • Quarto

Markup language converters may be used to write a document once and then export to different formats.

Pandoc

Pandoc converts from different file formats (for example, it converts from LaTeX to EPUB, that is XHTML-based.

It is FOSS.

Pandoc at Wikipedia

The document conversion functionality of Quarto publishing system is built on top of Pandoc.

List of documentation generators

Read the post software documentation generation.

Documentation generator:

  • Sphinx
  • Doxygen

Sphinx

Sphinx is a documentation generation software that converts markup language reStructuredText (by default) or MyST-markdown (using extensions) into structured and linked files.

Sphinx is FOSS under a BSD license.

Sphinx is mainly used for scientific documentation.

It is written in Python and used by the Python community.

Sphinx at Wikipedia

Sphinx official website

MyST-Parser is a Sphinx add-on that lets Sphinx read Markdown markup languages.

It connecting Sphinx’s document system (Docutils) with a Markdown parser library called markdown-it-py, which understands the CommonMark style of Markdown.

MyST-parser website

List of static site generators

A static code generator (SSG) generates a multi-page website.

Static code generators:

  • MkDocs
  • Hugo
  • JupyterBook
  • Docusaurus

MkDocs

MkDocs is scientific.

It uses Markdown markup language as a source and YAML for metadata.

MkDocs official website

Hugo

Hugo is FOSS.

Hugo official website

Publishing system

Publishing system:

  • Quarto

Quarto

Quarto is a FOSS scientific and technical publishing system. It uses the Pandoc Markdown markup language. It uses YAML for metadata.

Quarto is built on top of Pandoc for document conversion.

Related entries

Leave a Reply

Your email address will not be published. Required fields are marked *