diff options
author | Vincent Ambo <tazjin@google.com> | 2019-12-21T15·55+0000 |
---|---|---|
committer | Vincent Ambo <tazjin@google.com> | 2019-12-21T15·56+0000 |
commit | 671dbc7f72c2ccd1bbd1aa3ae66a0e627382eebd (patch) | |
tree | db957f8fdb7370d1c15860c46cc5bbfbe448d6d1 | |
parent | 42564b3956fab829502024230603749152baa7b3 (diff) |
docs(cheddar): Mention cgit filter compatibility in README r/286
-rw-r--r-- | tools/cheddar/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/tools/cheddar/README.md b/tools/cheddar/README.md index 96faa34a4f6b..706f3b62d552 100644 --- a/tools/cheddar/README.md +++ b/tools/cheddar/README.md @@ -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. |