Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hfagerlund/mkdocs-docskimmer
An accessible, skimmable theme for MkDocs
https://github.com/hfagerlund/mkdocs-docskimmer
accessible docskimmer-theme mkdocs-theme responsive theme
Last synced: about 2 months ago
JSON representation
An accessible, skimmable theme for MkDocs
- Host: GitHub
- URL: https://github.com/hfagerlund/mkdocs-docskimmer
- Owner: hfagerlund
- License: other
- Created: 2017-06-13T00:33:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-05T02:08:31.000Z (about 1 year ago)
- Last Synced: 2023-11-05T03:20:04.529Z (about 1 year ago)
- Topics: accessible, docskimmer-theme, mkdocs-theme, responsive, theme
- Language: CSS
- Homepage: https://hfagerlund.github.io/mkdocs-docskimmer/
- Size: 558 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# docSkimmer Theme
**docSkimmer** is a skimmable minimal theme for [MkDocs](https://github.com/mkdocs/mkdocs/). Supports [MkDocs versions >= 0.16.2](https://github.com/hfagerlund/mkdocs-docskimmer#version-compatibility).
*Figure 1: Screenshot of docSkimmer theme for MkDocs*
## Features
* accessible;
* responsive;
* valid HTML5 + CSS3;
* no fonts (include only what you prefer using `extra_css`);
* no libs - except for a single (~2KB) module (include only what you prefer using `extra_javascript`);
* supports MkDocs configuration features such as `google_analytics`.
## Installation
* Clone docSkimmer from GitHub:
```
$ git clone https://github.com/hfagerlund/mkdocs-docskimmer.git
```
Or [download the required version](https://github.com/hfagerlund/mkdocs-docskimmer/releases) - refer to: ['Version compatibility'](https://github.com/hfagerlund/mkdocs-docskimmer#version-compatibility).
(Not on PyPI yet.)
* Copy the contents of the `mkdocs_docskimmer` directory into the MkDocs project root (ie. at the same level as the `docs` directory).
## Usage
* Modify the following settings in the 'mkdocs.yml' file:
### For docSkimmer v0.3.x, v0.4.x:
```yaml
# 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:
```yaml
# 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:
```yaml
# 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:
```yaml
# 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](https://github.com/mkdocs/mkdocs/tree/decaf6141c90b0123a4b7f03ee839d0780570bc9) |
| 0.3.0 | [Pages refactor](https://github.com/mkdocs/mkdocs/tree/34ef3ca6d0390959080ce93a695361eea1649272) |
| 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 |
## Demo
A demo of the docSkimmer theme is available on its [documentation homepage](https://hfagerlund.github.io/mkdocs-docskimmer/).
## License
Copyright (c) 2017 Heini Fagerlund. Licensed under the [Simplified BSD License](https://github.com/hfagerlund/mkdocs-docskimmer/blob/master/LICENSE).