docSkimmer
docSkimmer is a skimmable minimal theme for static documentation sites built using MkDocs.
Supports MkDocs versions >= 0.16.2.
Features
- accessible;
- lightweight - no fonts or libs included (except for a single ~2KB module) - so that you can add only what you prefer;
- responsive;
- skimmable;
- valid HTML5 + CSS3.
Installation
- Clone docSkimmer from GitHub:
git clone https://github.com/hfagerlund/mkdocs-docskimmer.git
Or download the required version - refer to: 'Version compatibility'.
- Copy the contents of the '/mkdocs_docskimmer' directory into your MkDocs project root (ie. at the same level as the project's '/docs' directory).
Usage
- Modify the following settings in the 'mkdocs.yml' file:
For docSkimmer v0.3.x, v0.4.x:
# mkdocs.yml:
nav:
## add your custom pages hierarchy here
theme:
name: null
custom_dir: 'mkdocs_docskimmer'
include_search_page: true
search_index_only: false
static_templates:
- 404.html
plugins: ['search']
# add theme version number here
extra:
version: 0.3.x
For docSkimmer v0.2.1:
# mkdocs.yml:
pages:
## add your custom pages hierarchy here
theme:
name: null
custom_dir: 'mkdocs_docskimmer'
include_search_page: true
search_index_only: false
static_templates:
- 404.html
plugins: ['search']
extra:
version: 0.2.1
For docSkimmer v0.2.0:
# mkdocs.yml:
pages:
## add your custom pages hierarchy here
theme:
name: null
custom_dir: 'mkdocs_docskimmer'
static_templates:
- 404.html
extra:
version: 0.2.0
For docSkimmer v0.1.x:
# mkdocs.yml:
pages:
## add your custom pages hierarchy here
theme_dir: 'mkdocs_docskimmer'
Version compatibility
docSkimmer theme version(s) | MkDocs version(s) |
---|---|
0.4.0 | 1.0.4 |
0.3.1 | 1.0.4 Template URL filter addition |
0.3.0 | Pages refactor |
0.2.1 | 0.17.4 0.17.3 0.17.2 0.17.1 0.17.0 |
0.2.0 | 0.17.0 |
0.1.1 0.1.0 |
0.16.3 0.16.2 |
Examples
Examples of how Markdown syntax is rendered and how 2nd-level navigation is displayed in the docSkimmer theme are available on this sample page.