Packages

Tree-sitter parser and queries for markdown, mdx, compiled to WASM for Lumis

Current section

Files

Jump to
Raw

README.md

# lumis_wasm_markdown

Self-contained Lumis language package for markdown, mdx.

The Tree-sitter parser is compiled to WASM and ships with the queries that highlight it.

Built with [`tree-sitter build --wasm`](https://tree-sitter.github.io/tree-sitter/cli/build.html) `v`

[Lumis](https://lumis.sh) loads only the parsers a project depends on, so this dependency is what lets it highlight markdown, mdx.

## Installation

```elixir
def deps do
  [
    {:lumis, "~> 0.9"},
    {:lumis_wasm_markdown, "~> 0.26.0"}
  ]
end
```

## What it contains

`priv/parsers/` holds the parser and the manifest that describes it. The manifest records the parser's size, its SHA-256 and the queries.

Lumis reads both from there, so nothing is downloaded at runtime. `mix release` carries them like any dependency's assets.

The application has no code. It starts nothing and supervises nothing.

## Parser

| Parser | Version | Rev |
| ------ | ------- | --- |
| [https://github.com/tree-sitter-grammars/tree-sitter-markdown.git](https://github.com/tree-sitter-grammars/tree-sitter-markdown.git) | 0.5.3 | f969cd3ae3f9fbd4e43205431d0ae286014c05b5 |

## License

The Lumis packaging is MIT. The parser itself is redistributed from the
upstream project above; see that project for its license.