pdj-sitegen

pdj_sitegen

Pandoc and Jinja Site Generator

• docs: miv.name/pdj_sitegen/
• demo site: miv.name/pdj_sitegen/demo_site/
• source: github.com/mivanit/pdj-sitegen

Installation:

pip install pdj-sitegen

you should either have Pandoc installed, or you can run

python -m pdj_sitegen.install_pandoc

which will install pandoc using pypandoc

Usage

1. create a config file. For an example, see pdj_sitegen.config.DEFAULT_CONFIG_YAML, or print a copy of it via

python -m pdj_sitegen.config

1. adjust the config file to your needs. most importantly:

# directory with markdown content files and resources, relative to cwd
content_dir: content/
# directory with resources, relative to `content_dir`
resources_dir: resources/
# templates directory, relative to cwd
templates_dir: templates/
# default template file, relative to `templates_dir`
default_template: default.html.jinja2
# output directory, relative to cwd
output_dir: docs/

1. populate the content directory with markdown files, populate content/resources/ with resources (images, css, etc.), and adjust templates in the templates directory. See the demo site for usage examples.

2. run the generator

python -m pdj_sitegen your_config.yaml