How to Customize

You can expand or rewrite parts of the theme.

MkDocs offers a generic, detailed guide to customizing a MkDocs theme.

Stylesheets

Add your own CSS files to override the theme's default styles:

extra_css:
    - css/custom.css

JavaScript

Add your own JavaScript files to extend the theme's functionality:

extra_javascript:
    - js/custom.js

Templates & Assets

Override templates and assets of TACC theme or ReadTheDocs theme e.g.

  • img/logo.svg
  • img/favicon.ico
  • main.html
  • nav.html
  • footer.html
  • searchbox.html

To override a template:

  1. Create a directory called overrides in your docs directory.

  2. Add your custom templates e.g.

    docs/
├── overrides/
│   ├── main.html
│   └── footer.html

  3. Configure overrides via mkdocs.yml:

    theme:
    name: tacc_readthedocs
    custom_dir: overrides

More Options