https://github.com/vzhong/mkdocs_pug

Use pug templates with your mkdocs template
https://github.com/vzhong/mkdocs_pug

Last synced: 30 days ago
JSON representation

Use pug templates with your mkdocs template

• Host: GitHub
• URL: https://github.com/vzhong/mkdocs_pug
• Owner: vzhong
• Created: 2021-10-20T07:17:04.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-20T08:15:06.000Z (about 3 years ago)
• Last Synced: 2024-09-19T10:57:03.033Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mkdocs-pug

This MkDocs plugin is based on [pypugjs](https://github.com/kakulukia/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.