Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-ponylang, version 0.2.8
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_ponylang-0.2.8-py3-none-any.whl (142.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-ponylang-0.2.8.tar.gz (116.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page