mkdocs-ponylang 0.1.0

Ponylang Material theme for MkDocs

Ponylang Mkdocs Theme

A customized theme based on https://github.com/squidfunk/mkdocs-material for MkDocs of the Ponylang Standard Library documentation.

Usage

Install the theme from PyPI:

pip install mkdocs-ponylang

In your mkdocs.yml file, change the theme:

theme: ponylang

Development

You must have virtualenv and npm installed.

Installation

This will set up all of the necessary packages to install the theme locally.

git clone https://github.com/ponylang/mkdocs-theme
cd mkdocs-theme
virtualenv venv
source venv/bin/activate
pip install -e .
npm install

Build

Compile files from src/ with Webpack:

npm run build

Distribution

Upload to PyPI with Twine:

rm dist/*
python setup.py sdist bdist_wheel
twine upload dist/*