# Kirari (v1.0.1)

> Lightweight syntax highlighting with 48 languages, CSS-variable themes, React and Rehype integrations, and token streaming.

The guides below are plain Markdown, served from the same files used by the documentation website.

## Getting started

- [Introduction](https://kirari.sh/docs/overview.md): What Kirari is and how the pieces fit together.

## Customize

- [Languages](https://kirari.sh/docs/languages.md): Explore every opt-in language and format.
- [Themes](https://kirari.sh/docs/themes.md): Pick from built-in themes like GitHub, Dracula, Nord, and Catppuccin.
- [Custom themes](https://kirari.sh/docs/theming.md): Style token categories with CSS variables and classes.
- [Custom rendering](https://kirari.sh/docs/rendering.md): Use raw tokens and source offsets in your own UI.
- [Decorations](https://kirari.sh/docs/decorations.md): Add source ranges and line wrappers to highlighted HTML.

## Advanced

- [Streaming](https://kirari.sh/docs/streaming.md): Apply token patches as source chunks arrive.
- [Markdown fences](https://kirari.sh/docs/markdown.md): Resolve language aliases and highlight fenced code blocks.
- [Rehype & MDX](https://kirari.sh/docs/rehype.md): Highlight code blocks while building Markdown and MDX documents.
- [React](https://kirari.sh/docs/react.md): Render highlighted code as React elements, on the server or while streaming.
- [Custom grammars](https://kirari.sh/docs/grammars.md): Extend definitions with your own rules and categories.

## Reference

- [API reference](https://kirari.sh/docs/api.md): Core functions, optional entry points, and their options.
- [Scope & limits](https://kirari.sh/docs/limitations.md): Lexical coverage, trusted grammars, and runtime support.

## Resources

- [Complete documentation](https://kirari.sh/llms-full.txt): All guides in one Markdown document.
- [Playground](https://kirari.sh/playground/): Try code, languages, and themes.
- [Source code](https://github.com/vortexkit/kirari)
- [npm package](https://www.npmjs.com/package/@vortexlabs/kirari)