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: 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/*
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.1.0.tar.gz
(118.1 kB
view details)
Built Distribution
File details
Details for the file mkdocs-ponylang-0.1.0.tar.gz.
File metadata
- Download URL: mkdocs-ponylang-0.1.0.tar.gz
- Upload date:
- Size: 118.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 26943868f967c3470e08d1576597665c1a4601df1051415afbea6c47adef2e2e |
|
| MD5 | b8015ab765ceae393af461c2a6dceb50 |
|
| BLAKE2b-256 | 897011ab34d1e0a29841f641d2687adb1db39bf4880612c0858442a2c954c451 |
File details
Details for the file mkdocs_ponylang-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_ponylang-0.1.0-py3-none-any.whl
- Upload date:
- Size: 141.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9d0a4caaac188a006935d868580c6d420d81ed466221adb98e07dfb3940ae02 |
|
| MD5 | f0ffbdfce396368d0c34b97679fa7e33 |
|
| BLAKE2b-256 | b1e4a1180d11d5959d83bce8fac5c00227f0629fb106e5f2270d32791fdbf5ae |
