Skip to content

Updating the Theme

The theme for the docs is a custom version of the Material Design theme for MkDocs.

Check out the arundo-docs-theme repo to view the source code for the theme.


Instructions

Here's how to update a doc site to use the latest version of the Material Design theme.

  1. Open a command-line application.
  2. Run the pip install --upgrade mkdocs-material --user command.
  3. Note the version number for the update.
  4. Open the package.json file.
  5. Update the version number:

    {
    "name": "mkdocs-material",
    "version": "5.2.3",
    
  6. Save the file.

  7. Open the requirements.txt file.
  8. Update the mkdocs-material requirement:

    mkdocs-material>=5.2.3
    
  9. Save the file.

  10. At the command-line, browse to the doc site directory.
  11. Run the rm -fr node_modules command.
  12. Run the npm run build command.
  13. Run the mkdocs build command.

Last update: June 26, 2020