Lumis Docs

Installation

Install Lumis for CLI, Rust, Elixir, JavaScript, Browsers / CDN, and Java.

Pick the runtime you want to use first. The highlighting concepts stay the same across all of them.

npm install @lumis-sh/lumis @lumis-sh/themes

Use @lumis-sh/lumis for the per-language WASM runtime and @lumis-sh/themes for bundled themes. Node.js, Bun, Deno, and browsers use the same runtime model.

Notes

  • Highlighting loads the parsers a document needs, including languages injected inside it, and caches the verified bytes. See WASM and CDN.
  • Warm up parsers at startup without blocking it, or use the CLI when a build or operations step owns the cache.
  • For local JavaScript parser assets from npm, install per-language packages such as @lumis-sh/wasm-rust or bundle packages such as @lumis-sh/wasm-bundle-web.
  • The CLI stores verified, content-addressed parsers and custom themes in a local data directory.

Lumis Syntax Highlighting

Lumis is a Tree-sitter syntax highlighter with Neovim themes and one workflow across CLI, Rust, Elixir, JavaScript, Browsers / CDN, and Java.

Architecture

How Lumis processes source code into highlighted output.

On this page

Notes