Skip to main content

No project description provided

Project description

Jinja2 SSG

A very simple static site generator.

  • The filesystem structure in --src is copied into --dest.
  • Files and folders starting with _ are skipped.
  • By default only html, txt, js files are used and the rest of them are skipped.
  • YAML files can be used to provide data inside templates.
python3 -m pip install jinja2ssg
python3 -m jinja2ssg --src src --dest publish build

Example

site/src/
├── _base.html
├── _social_links.yaml
├── donate
│   └── index.html
├── _footer.html
├── index.html
└── _nav.html

Results in a DEST structure like:

site/www/
├── index.html
└── donate
    └── index.html

Common patterns

  • Run with inotify to rebuild on source file changes.
        inotifywait --recursive --monitor --format "%e %w%f" \
        --event modify,move,create,delete ./src \
        | while read changed; do
            echo $changed
            (python3 -m jinja2ssg build)
        done
    
  • Put social links inside _social.yaml files and access as {{ yaml._social.facebook }}
  • Access all build paths using {{ build_paths }}. Useful while writing service worker code to cache the site as a PWA.
  • Access {{ relative_path }} to know the path of the current file being rendered.

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

jinja2ssg-0.2.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

jinja2ssg-0.2.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file jinja2ssg-0.2.0.tar.gz.

File metadata

  • Download URL: jinja2ssg-0.2.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.4 Linux/5.4.0-172-generic

File hashes

Hashes for jinja2ssg-0.2.0.tar.gz
Algorithm Hash digest
SHA256 839597470422134c1b5324f0da4c337592e48f1aa07551b6b484559bbd012974
MD5 afa55f65aa2ea944ce3fd507f9ce8922
BLAKE2b-256 5a52bbd1c39b0f008bdea440d21ecd7356535e1bdabb88993d22996d9978906f

See more details on using hashes here.

File details

Details for the file jinja2ssg-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: jinja2ssg-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.4 Linux/5.4.0-172-generic

File hashes

Hashes for jinja2ssg-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cf6a760f490c5afe6aa416a7b27eb196796e030ca87038e73a21093773a26d3
MD5 8171aee9517448c3a34bd89b493aab3d
BLAKE2b-256 843257a7b7f668d8e261131829f75077695e726708138635ab7dbc1898750c1b

See more details on using hashes here.

Supported by

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