Skip to content

Commit f163adc

Browse files
committed
docs: add AGENTS.md
1 parent fe6f0f3 commit f163adc

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Chroma is a syntax highlighting library, tool and web playground for Go. It is based on Pygments and includes importers for it, so most of the same concepts from Pygments apply to Chroma.
2+
3+
This project is written in Go, uses Hermit to manage tooling, and Just for helper commands. Helper scripts are in ./scripts.
4+
5+
Language definitions are XML files defined in ./lexers/embedded/*.xml.
6+
7+
Styles/themes are defined in ./styles/*.xml.
8+
9+
The CLI can be run with `chroma`.
10+
11+
The web playground can be run with `chromad --csrf-key=moo`. It blocks, so should generally be run in the background. It also does not hot reload, so has to be manually restarted. The playground has two modes - for local development it uses the server itself to render, while for production running `just chromad` will compile ./cmd/libchromawasm into a WASM module that is bundled into `chromad`.

0 commit comments

Comments
 (0)