MkDocs UBL theme for documentation

MkDocs UBL is a theme for writing documentation using the Leiden University Libraries style and colors. MkDocs UBL template is based on Material for MkDocs; a theme for MkDocs. MkDocs is static site generator geared towards (technical) project documentation.

Installation

The MkDocs UBL theme can be installed with pip:

First, make sure you have installed Python v3.* on your machine. During the installation you will be asked if you also want to install 'pip'. Do so, and then run the following command to install all the dependencies to run MkDocs with the theme on your machine:

pip install mkdocs-ubleiden-theme

This will automatically install compatible versions of all dependencies: MkDocs, Material for MkDocs, Markdown, Pygments and Python Markdown Extensions. There's no need to install these packages separately.

Using this theme in your project

Following the [Styling your docs guide][style], set the theme to ubleiden in your mkdocs.yml configuration file:

theme: ubleiden

or:

theme:
  name: ubleiden

Generating the documentation

If you have installed Python 3.* and MkDocs, you can use the command mkdocs serve, or python -m mkdocs serve in your terminal to serve the documentation on your development computer. For example:

C:\Users\username\Documents\my-cool-application> python -m mkdocs serve

When you are ready to generate the final documentation files, run mkdocs build to create a static version locally, or mkdocs gh-deploy to build and push the docs to a special branch in your remote git repository.

For more information about generating and publishing the documentation, see Deploying your Docs.