UBL theme for MkDocs, extending Material for MkDocs
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-ubleiden-theme-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82de8a44f240b22457f8e85416ef793a1262b900c36fe5e1c1164ca0c7d1a21c |
|
MD5 | 2d1e5e6deec21d54e5cc61ce7f42a8b2 |
|
BLAKE2b-256 | d8deca8e62d765406c783bb264c8ea923e51a30a591d8cf951a67f85766b6632 |
Hashes for mkdocs_ubleiden_theme-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fee1d3c81ff82bb44b67d009f432293893a2497fb0a1cb84876d79a6109d2be |
|
MD5 | 8f76cc811cc33295178688451a948ee9 |
|
BLAKE2b-256 | 1564349030f3cb1015edab8835a27e26956567d2dc827372ee30bb653df613cc |