tvl-depot/tools/cheddar
Vincent Ambo 5e08f9b6c6 refactor(cheddar): Support multiple shortlinks & custom link sets
This makes it possible for users of cheddar as a library to supply
their own shortlinks. In practice it is unlikely anyone will do this,
but the change also allows us to (relatively) easily add additional
shortlinks to the set used by TVL.

Note that Cheddar is primarily intended for use by TVL and the default
rendering function interfaces have not changed, and will default to
using TVL shortlinks.

A new public function `format_markdown_with_shortlinks` has been added
with which users can use an alternative set of shortlinks. This
function should not be used in TVL depot code.

Change-Id: I4ddab28cbcf45d07c51323b7b730b96e62922816
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3083
Tested-by: BuildkiteCI
Reviewed-by: lukegb <lukegb@tvl.fyi>
2021-09-10 11:32:33 +00:00
..
src refactor(cheddar): Support multiple shortlinks & custom link sets 2021-09-10 11:32:33 +00:00
.gitignore feat(tools/cheddar): Check in new syntax highlighting tool 2019-12-21 04:54:57 +00:00
.skip-subtree feat(tools/cheddar): Check in new syntax highlighting tool 2019-12-21 04:54:57 +00:00
build.rs docs(cheddar): fix typo in build.rs comment 2021-05-12 15:38:57 +00:00
Cargo.lock feat(cheddar): Implement highlighting of CL and bug shortlinks 2021-05-04 15:50:26 +00:00
Cargo.toml feat(cheddar): Implement highlighting of CL and bug shortlinks 2021-05-04 15:50:26 +00:00
default.nix chore(3p/overlays): Remove LLVM11 bump from overlay 2021-05-24 18:15:05 +00:00
README.md docs(cheddar): Mention cgit filter compatibility in README 2019-12-21 15:56:44 +00:00

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:

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.