Current section
Files
Jump to
Current section
Files
README.md
# Jinks

[](https://hex.pm/packages/jinks)
[](https://jinks.hexdocs.pm/)
[](https://github.com/peregrinefinch/jinks/actions/workflows/test.yml)
Jinks builds static sites from Markdown, TOML, and Tuck. Give a site a theme,
preview changes as you write, and publish the generated files anywhere.
[Website](https://peregrinefinch.github.io/jinks-website/) · [Installation and docs](https://peregrinefinch.github.io/jinks-website/docs/)
With Jinks installed:
```sh
jinks init my-site
jinks serve my-site
```
Run `jinks build my-site` to write the site to `my-site/public/`.
## Licence
Licensed under the [Apache License, Version 2.0](LICENSE).