Packages

A little mischief for the static web

Current section

Files

Jump to
jinks README.md
Raw

README.md

# Jinks

![Jinks — a little mischief for the static web](assets/jinks.png)

[![Hex](https://img.shields.io/hexpm/v/jinks?style=for-the-badge&color=6B5BA7)](https://hex.pm/packages/jinks)
[![HexDocs](https://img.shields.io/badge/HexDocs-jinks-FFB347?style=for-the-badge)](https://jinks.hexdocs.pm/)
[![Tests](https://img.shields.io/github/actions/workflow/status/peregrinefinch/jinks/test.yml?style=for-the-badge&label=tests)](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).