tvl-depot/tools/cheddar/README.md

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
feat(tools/cheddar): Check in new syntax highlighting tool The first step with this tool will be to use it as a source-filter for cgit. The second step is to use it as the Markdown renderer by depending on one of the Markdown libraries, with integration for rendering code snippets directly. 2019-12-21 05:20:15 +01:00			`cheddar`
			`=======`

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

docs(cheddar): Mention cgit filter compatibility in README 2019-12-21 16:55:59 +01:00			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.`

feat(tools/cheddar): Check in new syntax highlighting tool The first step with this tool will be to use it as a source-filter for cgit. The second step is to use it as the Markdown renderer by depending on one of the Markdown libraries, with integration for rendering code snippets directly. 2019-12-21 05:20:15 +01:00			`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`