mkdocs-ubleiden-theme 1.0.0

UBL theme for MkDocs, extending Material for MkDocs

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

Detailed installation and customization instructions are available on the official MkDocs Material documentation. Here's a short overview.

Material for MkDocs 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 on your machine:

pip install mkdocs-material

This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.

Using this template in your project

One you have followed the installation guide, clone or download the contents of this repository and place the files in your new project. You can start adding text to your documentation or make any adjustments you need.

Displaying the docs

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

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