mkdocs-cluster theme

This project provides an MkDocs Bootstrap theme heavily based on mkdocs-bootstrap

Features

Libraries:

changelog

Installation

From pip

    pip install mkdocs-cluster

Then edit your mkdocs.yml file and set the theme to cluster:

theme: cluster

From source

    # Install from source:
    git clone https://gitlab.com/kaliko/mkdocs-cluster.git cluster
    # fecth web libaries
    cd cluster && sh ./do get_libs

After the theme is built, edit your mkdocs.yml file and set the theme_dir to mkdocs_cluster:

theme_dir: cluster/mkdocs_cluster

Or you can build/install:

    # fecth web libaries
    cd cluster && sh ./do get_libs
    ./setup.py install

Theme

Repo name

Handles GitLab, Bitbucket, GitHub and falls back to fa-code-fork

Table of content

TOC is generated when:

For instance:

# Title

This will not trigger TOC rendering

# Title

## SubTitle0
Some text

## SubTitle1
This will trigger TOC rendering

# Title0

# Title1
Some text

# Title2
This obviously will…

Configuration

Theme configuration is done thanks to extra vars:

pages:
   - About:   about/index.md
   - Contact: about/contact.md
   - MailUs:  about/mail.md

extra:
    prev_next_enabled: False
    nav_right: ['About', 'Contact']
    hidden: ['Home', 'MailUs']
    fa_logo: 'fa-cube'