mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(cheddar): Mention cgit filter compatibility in README

Browse source
This commit is contained in:
Vincent Ambo 2019-12-21 15:55:59 +00:00
parent 42564b3956
commit 671dbc7f72
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
tools/cheddar/README.md
View file

@ -4,6 +4,17 @@ cheddar
Cheddar is a tiny Rust tool that uses [syntect][] to render source code to Cheddar is a tiny Rust tool that uses [syntect][] to render source code to
syntax-highlighted HTML. 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 The name was chosen because I was eyeing a pack of cheddar-flavoured crisps
while thinking about name selection. while thinking about name selection.