Skip to main content

mkdocs theme based on DOCter

Project description

# mkDOCter

mkDOCter is an [MkDocs](http://www.mkdocs.org/) theme based on the
[DOCter template for Jekyll](https://github.com/ascott1/DOCter).

## Usage

Use pip to install mkDOCter. If you're using mkdocs within a
[virtualenv](https://virtualenv.pypa.io/en/stable/), please be sure to
install mkDOCter into the same virtualenv.

```
pip install mkDOCter
```

Once installed, you can add mkDOCter to your mkdocs configuraiton file:

```
theme: mkDOCter
```

## Configuration

mkDOCter has a few config extras to customize its appearances:

```
extras:
brand_color: "#1096CF"
logo_url: http://xmlsoft.org/catalog.gif
logo_alt: My Awesome Logo
```

*`brand_color`* controls the header and sidebar accent lines.

*`logo_url`* is the URL to a logo to display in the top right.

*`logo_alt`* is the alt text for the logo.

## License

The project is in the public domain, and all contributions to it will be
released as such. By submitting a pull request, you are agreeing to
waive all rights to your contribution under the terms of the
[CC0 Public Domain Dedication](TERMS.md).

If you contribute the open source work of others, please mark it clearly
in your pull request.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkDOCter, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size mkDOCter-1.0.5-py2.py3-none-any.whl (13.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size mkDOCter-1.0.5.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page