MkDocs TACC Theme

A TACC-styled MkDocs theme based on MkDocs' own ReadTheDocs theme.

How to Create a New Project

Follow the steps in Create a New MkDocs-TACC Project.

How to Install on Existing Project

1. Install the theme (with all or zero extra functionality).

   PIP

   For all features

   pip install "mkdocs-tacc[all]"

   To change text, like "Edit on GitHub"

   pip install "mkdocs-tacc[i18n]"

   For extra Markdown syntax

   pip install "mkdocs-tacc[pymdown-extensions]"

   For minimal install

   pip install mkdocs-tacc

   Poetry

   For all features

   poetry add "mkdocs-tacc[all]"

   To change text, like "Edit on GitHub"

   poetry add "mkdocs-tacc[i18n]"

   For extra Markdown syntax

   poetry add "mkdocs-tacc[pymdown-extensions]"

   For minimal install

   poetry add mkdocs-tacc

2. Use the theme in your MkDocs project; set —

   theme:
       name: tacc_readthedocs

   — in your mkdocs.yml.

3. Include the typical or minimal set of extensions — e.g.

   markdown_extensions:
     - toc:
         permalink: "" # i.e. `true` but without "¶"
         permalink_class: headerlink fa fa-link
         permalink_title: Link to Heading

   — in your mkdocs.yml.

Configure & Customize

You can configure the appearance and behavior.

You can expand or rewrite parts of the theme.

Supported Extensions

This theme supports many Markdown extensions.