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.
Install the theme from PyPI:
pip install mkdocs-ponylang
mkdocs.yml file, change the theme:
theme: name: ponylang
Table of contents
# Enable permalinks markdown_extensions: - markdown.extensions.toc: permalink: true # Set maximum depth theme: max_toc_depth: 2
theme: palette: primary: brown accent: amber
You can choose from primary and accent colors listed here.
theme: favicon: asserts/image/logo.png logo: icon: cloud
Logos can be images or Material icons (more info here).
repo_name: ponylang/ponyc repo_url: https://github.com/ponylang/ponyc
Extra customization options are available in the Material theme documentation.
- Python 3
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 python -m venv venv source venv/bin/activate pip install -e . npm install
Compile files from
src/ with Webpack:
npm run build
Upload to PyPI with Twine by calling the following Makefile targets:
make clean make upload-to-pypi
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
mkdocs-ponylang-0.2.8.tar.gz (116.6 kB view hashes)
Hashes for mkdocs_ponylang-0.2.8-py3-none-any.whl