teedoc

teedoc is an open-source static site generator that converts Markdown files and jupyter notebooks to a documentation website. teedoc is written in the Python programming language, easy to use and extend. teedoc is especially suitable for multiple documentation sites, wikis, or knowledge bases.

teedoc uses the mistune Markdown parser.

teedoc Markdown Support

teedoc provides support for the following Markdown elements.

Support for Additional Syntax Elements

teedoc supports many useful additional syntax like:

• mermaid: A simple markdown-like script language for generating charts from text via javascript.
• math: Supports Latex, tex math syntax, and MathML tags.

• tabset: A easy to use tabset syntax. For example, it shows different code examples for different programming languages.

    .. tabset::
        :id: tabset1
  
        ## Kotlin
  
        Content 1, full Markdown syntax support
  
        ## Java
  
        Content 2, full Markdown syntax support
  

  will be rendered to:

  <div class="tabset tabset-id-tabset1">
    <div class="tabset-title">Title(optional)</div>
    <div class="tabset-content">
      <div class="tabset-tab">
        <span class="tabset-tab-label tabset-tab-active" idx="0">Kotlin</span>
        <span class="tabset-tab-label " idx="1">Java</span>
      </div>
      <div class="tabset-text-container">
          <div class="tabset-text tabset-text-active" idx="0">
            <p>Content 1, full Markdown syntax support</p>
          </div>
          <div class="tabset-text" idx="1">
            <p>Content 2, full Markdown syntax support</p>
          </div>
      </div>
    </div>
  </div>
  

• details: A syntax to generate HTML5 details tag.

    .. details::Title, click to expand
  
        Content, full Markdown syntax support
  

  will be rendered to:

    <details>
      <summary>Title, click to expand</summary>
      <div class="details-content">
        <p>Content, full Markdown syntax support</p>
      </div>
    </details>
  

For more syntax information, visit teedoc markdown syntax.

See Also

• teedoc Markdown Features

Take your Markdown skills to the next level.

Learn Markdown in 60 pages. Designed for both novices and experts, The Markdown Guide book is a comprehensive reference that has everything you need to get started and master Markdown syntax.

Get the Book