Ponylang theme for MkDocs
Project description
Based on https://github.com/rtfd/sphinx_rtd_theme and https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes/readthedocs .
The sources for generating the theme files is mostly in src folder, it is generated using webpack. The theme itself is distributed as python package and can be referenced in your mkdocs.yml as:
theme: ponylang
Setup
You need to have npm installed. I installed it using asdf, but any installation method will do.
Install yarn to install further dependencies:
npm install -g yarn yarn install
In order to regenerate the theme files inside the mkdocs_ponylang folder, run:
webpack
The Webpack executable should be in your global node installation and thus on your path. If not, search for it and add it to your path.
For an asdf installation, adding this to my shell initialization file (e.g. $HOME/.bashrc) helped:
export PATH="$HOME/.asdf/installs/nodejs/$(asdf which nodejs)/.npm/bin:$PATH"
Installation
Local Development
git clone git@github.com:mfelsche/ponylang-mkdocs-theme.git cd ponylang-mkdocs-theme pip install -e .
From Git
pip install -e git+https://github.com/mfelsche/ponylang-mkdocs-theme#egg=mkdocs_ponylang
From PyPI
pip install mkdocs-ponylang
Usage
Reference this theme from your mkdocs.yml configuration file like so:
theme: ponylang
Publishing
The package is packaged and distributed on the Python Package Index (PyPI).
pip install -U wheel twine cd ponylang-mkdocs-theme rm -rf ./dist/* python setup.py sdist bdist_wheel twine upload
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
Built Distribution
Hashes for mkdocs_ponylang-0.0.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3bc0a6b23d0734765f8bdcbf01424a8f0159e2a47519af6705f734104ac07e1 |
|
MD5 | d45f9650163e011ac5c5af8be2c28043 |
|
BLAKE2b-256 | ad46ea06a6fa7c674cd9578378052f61636a01d76e99db5729985c22e9be388f |