mkdocs-tacc 0.2.0

TACC ReadTheDocs theme for MkDocs

TACC MkDocs Theme & Guide & Demo

A guide and demo for TACC's MkDocs documentation theme based on MkDocs' own ReadTheDocs theme but with a TACC styling and features.

Quick Start

1. Install the theme e.g.

   pip install mkdocs-tacc
   

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

   theme:
       name: tacc_readthedocs
   

   — in your mkdocs.yml.

3. Include at least the [minimum set of extensions] —

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

   — in your mkdocs.yml.

Learn to configure, customize, and extend your MkDocs site.

Known Clients

Status	Repository
Active	None
Upcoming	TACC-Docs DesignSafe-CI/DS-User-Guide
Potential	TACC/containers_at_tacc TACC/life_sciences_ml_at_tacc

For Developers

Learn how to develop and how to deploy.