Skip to main content

Pug plugin for mkdocs.

Project description

mkdocs-pug

This MkDocs plugin is based on pypugjs.

To install:

pip install mkdocs_pug

To use, add this to your mkdocs.yml:

plugins:
  - mkdocs_pug

Then, this plugin will watch for *.pug files in your template directories and build the corresponding *.html files in the same location.

To do this automatically with the server during development, you should run with

mkdocs serve --watch-theme

This repo contains an example of how to use this plugin inside an MkDocs project.

Project details


Download files

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

Source Distribution

mkdocs_pug-0.0.2.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file mkdocs_pug-0.0.2.tar.gz.

File metadata

  • Download URL: mkdocs_pug-0.0.2.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for mkdocs_pug-0.0.2.tar.gz
Algorithm Hash digest
SHA256 c60e86fafd0fb56b42dde2d47f285acc34d86a2bc64a929a1599e24b478583b3
MD5 09adaf48e2b3966640376e167b6f230b
BLAKE2b-256 628191412ecae8f6f8320dc67f2cc3800170738ef491012f9a9e08ec32d88e2f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page