Skip to main content

A simple static site generator - supports Markdown, YAML and JSON inputs and Jinja2 templating

Project description

PyPI version

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

Installation

Papery is available on pypi.

pip 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.

TODO

  • documentation
  • styling with SASS/SCSS

License

Copyright 2013-2023 Xcoo, Inc.

Licensed under the Apache License, Version 2.0.

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

papery-0.8.0.tar.gz (23.5 kB view details)

Uploaded Source

File details

Details for the file papery-0.8.0.tar.gz.

File metadata

  • Download URL: papery-0.8.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.1

File hashes

Hashes for papery-0.8.0.tar.gz
Algorithm Hash digest
SHA256 c11ca5691da83910756b0960cb321a28bb9d468584749d8064fbad926326232e
MD5 5c40f6f745329cd74fb5f37847dd779c
BLAKE2b-256 399fdf2f3d13eb5afd12b903acce79cf80034865015f0caee9124f40638257ab

See more details on using hashes here.

Supported by

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