Skip to content

keenlycode/engrave

Repository files navigation

Engrave

Engrave is a lightweight static-site generator built with Python and Jinja2. It is designed for small documentation sites, landing pages, and simple content-driven sites that benefit from templating without adding a backend.

Installation

pip install engrave

Simple CLI usage

Engrave has three core commands:

  • engrave build renders a site once
  • engrave watch rebuilds on change
  • engrave server rebuilds on change and starts a local preview server

Use engrave --help or engrave <command> --help for full command details.

Build once:

engrave build --dir-src site --dir-dest build

Watch and rebuild:

engrave watch --dir-src site --dir-dest build

Run the preview server:

engrave server --dir-src site --dir-dest build

Testing

python -m unittest

Development

Build package artifacts:

uv build

Build docs:

uv sync --group dev
uv run mkdocs build

Preview docs locally:

uv run mkdocs serve

Changelog

See CHANGELOG.md for release notes.

License

MIT. See LICENSE.

Packages

 
 
 

Contributors