docs(cheddar): Mention cgit filter compatibility in README
This commit is contained in:
parent
42564b3956
commit
671dbc7f72
1 changed files with 11 additions and 0 deletions
|
@ -4,6 +4,17 @@ 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.
|
||||
|
||||
|
|
Loading…
Reference in a new issue