Ponylang Material theme for MkDocs
Project description
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:
name: ponylang
Customization
Table of contents
# Enable permalinks
markdown_extensions:
- markdown.extensions.toc:
permalink: true
# Set maximum depth
theme:
max_toc_depth: 2
Palette
theme:
palette:
primary: brown
accent: amber
You can choose from primary and accent colors listed here.
Icons
theme:
favicon: asserts/image/logo.png
logo:
icon: cloud
Logos can be images or Material icons (more info here).
Source repository
repo_name: ponylang/ponyc
repo_url: https://github.com/ponylang/ponyc
Other customizations
Extra customization options are available in the Material theme documentation.
Development
Requirements
- Python 3
- npm
- libpng-dev
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
python -m venv 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 by calling the following Makefile targets:
make clean
make upload-to-pypi
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs-ponylang-0.2.8.tar.gz
(116.6 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_ponylang-0.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec41803ef8ea8267d06972b6a4847e840fc636559276fa2abfd32fb1e0267bed |
|
MD5 | f3310eebf68e736103b54a3371ad6c3a |
|
BLAKE2b-256 | 92506a20aa761bb992b4ca7f00f0678569aabc569b6e981375a8ff927d009c66 |