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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs-ponylang-0.2.8.tar.gz.
File metadata
- Download URL: mkdocs-ponylang-0.2.8.tar.gz
- Upload date:
- Size: 116.6 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b5f4418cc6e8f233b6b9eadd5941b172e98808be0935478c287ec57ac19b433
|
|
| MD5 |
c88fb121b6f3404a92b0f80407d0c2f4
|
|
| BLAKE2b-256 |
6473471cd1f4a90dc32e84a3803f65bfd91b4c1f4e1fe6a359034d90a5be588b
|
File details
Details for the file mkdocs_ponylang-0.2.8-py3-none-any.whl.
File metadata
- Download URL: mkdocs_ponylang-0.2.8-py3-none-any.whl
- Upload date:
- Size: 142.7 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec41803ef8ea8267d06972b6a4847e840fc636559276fa2abfd32fb1e0267bed
|
|
| MD5 |
f3310eebf68e736103b54a3371ad6c3a
|
|
| BLAKE2b-256 |
92506a20aa761bb992b4ca7f00f0678569aabc569b6e981375a8ff927d009c66
|
