MkDocs TACC Theme

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

• Either Create a New MkDocs-TACC Project
• Or Install Theme Into Existing MkDocs Project

Create a New MkDocs-TACC Project

1. Create a repository from our mkdocs-tacc-client template. How?
2. In your new repository:
   • Rename mkdocs_tacc_client directory to your_project_name.
   • Rename all instances of TACC/mkdocs-tacc-client to YourOrgOrUser/your-repo-name.
   • In pyproject.toml, change:
     • the name to your-project-name
     • the description
     • the homepage URL
   • In CONTRIBUTING.md, change:
     • the [issues]: URL
     • the [proposals]: URL
   • In README.md, change the title.

Install Theme Into Existing MkDocs Project

1. Enter the directory of your MkDocs project e.g.

   cd path/to/your/mkdocs/project

2. Install the theme (and optional dependencies) e.g.

   pip install "mkdocs-tacc[all]"

Note

We also offer detailed instructions instead.

How to Use

3. In your mkdocs.yml:

   • Set theme name as tacc_readthedocs.
   • Set typical extensions for this theme.

Known Clients

Status	Repository
Active	TACC-Docs digital-porous-media/dpm_docs
Upcoming	DesignSafe-CI/DS-User-Guide
Potential	TACC/containers_at_tacc TACC/life_sciences_ml_at_tacc

Contributing

We welcome contributions. Read "How to Contribute".