Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

mkdocs theme based on DOCter

Project Description

mkDOCter is an MkDocs theme based on the DOCter template for Jekyll.

Usage

Use pip to install mkDOCter. If you’re using mkdocs within a virtualenv, 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.

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

Release History

Release History

This version
History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
mkDOCter-1.0.4-py2.py3-none-any.whl (13.4 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Sep 5, 2017
mkDOCter-1.0.4.tar.gz (11.7 kB) Copy SHA256 Checksum SHA256 Source Sep 5, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting