about summary refs log tree commit diff
path: root/tools/cheddar/README.md
blob: 706f3b62d552ddb0a13a8a74b31edc4f7273a647 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
cheddar
=======

Cheddar is a tiny Rust tool that uses [syntect][] to render source code to
syntax-highlighted HTML.

It's invocation is compatible with `cgit` filters, i.e. data is read from
`stdin` and the filename is taken from `argv`:

```shell
cat README.md | cheddar README.md > README.html

```

In fact, if you are looking at this file on git.tazj.in chances are that it was
rendered by cheddar.

The name was chosen because I was eyeing a pack of cheddar-flavoured crisps
while thinking about name selection.

[syntect]: https://github.com/trishume/syntect