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.
- Open a command-line application.
- Run the
pip install --upgrade mkdocs-material --usercommand. - Note the version number for the update.
- Open the
package.jsonfile. -
Update the version number:
{ "name": "mkdocs-material", "version": "5.2.3", -
Save the file.
- Open the
requirements.txtfile. -
Update the
mkdocs-materialrequirement:mkdocs-material>=5.2.3 -
Save the file.
- At the command-line, browse to the doc site directory.
- Run the
rm -fr node_modulescommand. - Run the
npm run buildcommand. - Run the
mkdocs buildcommand.
Last update: June 26, 2020