Static site generator with Jinja2 templates and structured content in Markdown, YAML, and JSON
- Describe content with Markdown, YAML, and JSON
- Jinja2 templating
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)
Papery is available on pypi.
pip install paperyor, with uv:
uv tool install paperyRun the following command
cd path/to/your_site/directory
papery initpapery runYou can see your web site via http://localhost:8000. All pages are automatically updated when you modified any resources.
papery buildYou 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.
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/- documentation
- styling with SASS/SCSS
Copyright 2013-2023 Xcoo, Inc.
Licensed under the Apache License, Version 2.0.