Metadata-Version: 2.1
Name: mkdocs-ubleiden-theme
Version: 1.0.0
Summary: UBL theme for MkDocs, extending Material for MkDocs
Home-page: https://github.com/LeidenUniversityLibrary/mkdocs-ubleiden-theme
Author: Leiden University Libraries
Author-email: beheer@library.leidenuniv.nl
License: GPLv3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs-material

# 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][1]; a theme for 
[MkDocs][2].
MkDocs is static site generator geared towards (technical) project
documentation.

[1]: https://squidfunk.github.io/mkdocs-material/
[2]: https://www.mkdocs.org

## Installation

Detailed installation and customization instructions are available on the
official [MkDocs Material documentation](https://squidfunk.github.io/mkdocs-material/getting-started/).
Here's a short overview.

Material for MkDocs can be installed with `pip`:

First, make sure you have installed [Python v3.*](https://www.python.org/downloads/) 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:

```shell
pip install mkdocs-material
```

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

[5]: https://python-markdown.github.io/
[6]: https://pygments.org/
[7]: https://facelessuser.github.io/pymdown-extensions/

## 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:

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