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
1 maintainer
Release files for mkdocs-ponylang 0.2.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-ponylang-0.2.8.tar.gz | 116.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_ponylang-0.2.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 259.2 kB
Release files / mkdocs-ponylang-0.2.8.tar.gz
| Download URL | mkdocs-ponylang-0.2.8.tar.gz |
|---|---|
| Size | 116.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8b5f4418cc6e8f233b6b9eadd5941b172e98808be0935478c287ec57ac19b433
|
|
BLAKE2b-256 checksum How to use checksums |
6473471cd1f4a90dc32e84a3803f65bfd91b4c1f4e1fe6a359034d90a5be588b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.4.2 requests/2.21.0 setuptools/53.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5
|
Release files / mkdocs_ponylang-0.2.8-py3-none-any.whl
| Download URL | mkdocs_ponylang-0.2.8-py3-none-any.whl |
|---|---|
| Size | 142.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ec41803ef8ea8267d06972b6a4847e840fc636559276fa2abfd32fb1e0267bed
|
|
BLAKE2b-256 checksum How to use checksums |
92506a20aa761bb992b4ca7f00f0678569aabc569b6e981375a8ff927d009c66
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.4.2 requests/2.21.0 setuptools/53.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5
|
