Popular documentation tools
===========================

Read the Docs provides documentation hosting for any tool that can output HTML.
We provide a number of features that are well-suited to documentation specifically,
but you can host any kind of HTML content on Read the Docs.

Below is a list of popular documentation tools that you can use to write your documentation.

.. seealso::

   :doc:`/build-customization`
   Learn how to build documentation with any tool.

.. grid:: 2

    .. grid-item-card::  MkDocs
        :link: mkdocs.html

        MkDocs is a powerful documentation tool for markdown.

        Supported formats
             :bdg-success:`md`
        Written in
             :bdg-info:`python`

    .. grid-item-card::  Zensical
        :link: zensical.html

        Zensical is a static-site generator built by the creators of Material for MkDocs.

        Supported formats
             :bdg-success:`md`
        Written in
             :bdg-info:`rust` :bdg-info:`python`

    .. grid-item-card::  Sphinx
        :link: sphinx.html

        Sphinx is a powerful documentation generator that has many features for writing technical documentation.

        Supported formats
             :bdg-success:`rst` :bdg-success:`md`
        Written in
             :bdg-info:`python`

    .. grid-item-card::  Docusaurus
        :link: docusaurus.html

        Docusaurus is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.

        Supported formats
             :bdg-success:`mdx` :bdg-success:`md`
        Written in
             :bdg-info:`React`

    .. grid-item-card::  Markdoc
        :link: markdoc.html

        Markdoc is a documentation tool developed by Stripe that allows you to write documentation in a custom Markdown flavor.

        Supported formats
             :bdg-success:`md`
        Written in
             :bdg-info:`javascript`

    .. grid-item-card::  mdBook
        :link: mdbook.html

        mdBook is a command line tool to create books with Markdown built in Rust.

        Supported formats
             :bdg-success:`md`
        Written in
             :bdg-info:`rust`

    .. grid-item-card::  VitePress
        :link: vitepress.html

        VitePress is a static site generator with a focus on performance and simplicity.

        Supported formats
             :bdg-success:`md`

        Written in
             :bdg-info:`typescript`

    .. grid-item-card::  Antora
        :link: antora.html

        Antora is a static site generator for creating documentation sites from AsciiDoc content.

        Supported formats
             :bdg-success:`adoc`

        Written in
             :bdg-info:`javascript`

    .. grid-item-card::  MyST Markdown
        :link: mystmd.html

        MyST Markdown is a powerful authoring framework for scientific communication including blogs, books, papers, and articles.

        Supported formats
             :bdg-success:`md` :bdg-success:`ipynb`

        Written in
             :bdg-info:`javascript`

.. toctree::
   :hidden:

   /intro/sphinx
   /intro/mkdocs
   /intro/docusaurus
   /intro/markdoc
   /intro/mdbook
   /intro/vitepress
   /intro/antora
   /intro/zensical
   /intro/mystmd