Papery

Static site generator with Jinja2 templates and structured content in Markdown, YAML, and JSON

Features

• Describe content with Markdown, YAML, and JSON
• Jinja2 templating

Requirements

• Python 3.9+
• Jinja2
• markdown
• pymdown-extensions
• Pygments
• pyyaml
• yamllint
• pykwalify

The following Node.js tools are optional. If installed, they are used for validation.

• jsonlint (npm install -g jsonlint)
• markdownlint-cli (npm install -g markdownlint-cli)

Installation

Papery is available on pypi.

pip install papery

or, with uv:

uv tool install papery

Usage

Creating a new site

Run the following command

cd path/to/your_site/directory
papery init

Run with the development server

papery run

You can see your web site via http://localhost:8000. All pages are automatically updated when you modified any resources.

Build manually

papery build

Apply local Markdownlint rules

You can set local Markdownlint rule file for Markdown file validation. By setting it anywhere under path/to/your_site/directory, it has priority over the default rules.

Filenames ending with markdownlint.yaml or markdownlint.yml can be used to apply Markdownlint local rules.

Development

uv sync          # create .venv with dependencies
uv run papery    # run the CLI from the working tree
uv run pytest    # run tests
uv build         # build sdist and wheel into dist/

TODO

• documentation
• styling with SASS/SCSS

License

Copyright 2013-2023 Xcoo, Inc.

Licensed under the Apache License, Version 2.0.