hub / github.com/bruits/satteri
github.com/bruits/satteri @satteri-napi-v0.4.6
Chat with this repo
3,901 symbols
12,322 edges
246 files
624 documented · 16%
1 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
Here the page is set, the loose locked fast, the words marked down.
High-performance Markdown and MDX processing. Parses and compiles in Rust, runs your plugins in JavaScript.
Check out the documentation for installation instructions, the API reference, and usage examples, try it online on the playground, or join us on Discord!
Packages
Sätteri is a Rust + TypeScript monorepo containing the following Rust crates:
| Name | Description | Registry | README |
|---|---|---|---|
satteri |
High-level Rust API for the pipeline: parse, convert, compile |  |
README |
satteri-arena |
Arena allocator and binary buffer primitives |  |
README |
satteri-ast |
MDAST and HAST node types, codecs, tree operations, and conversion |  |
README |
satteri-plugin-api |
Rust Plugin trait for Rust plugins, typed visitors, and runner |
 |
README |
satteri-napi-binding |
NAPI bindings exposing the Rust pipeline to JavaScript | — | README |
satteri-mdxjs-rs |
MDX-to-JavaScript compiler, fork of mdxjs-rs adapted for OXC |  |
README |
satteri-pulldown-cmark |
CommonMark parser with MDX extension support, fork of pulldown-cmark |  |
README |
And the following npm packages:
| Name | Description | Registry | README |
|---|---|---|---|
satteri |
TypeScript layer: plugin API and top-level functions |  |
README |
satteri-expressive-code |
HAST plugin: render code blocks with Expressive Code |  |
README |
vite-plugin-satteri |
Vite plugin: import .md and .mdx files |
 |
README |
Acknowledgements
Sätteri builds on the work and knowledge of several open-source projects:
- unifiedjs -- the ecosystem of tools for processing content with syntax trees, including remark and rehype
- pulldown-cmark -- CommonMark pull parser
- mdxjs-rs -- MDX compiler by Titus Wormer, forked to use pulldown-cmark and OXC
Special thanks to the following projects for paving the way for high-performance Rust <-> JavaScript interop:
- oxc -- Rust JavaScript parser and compiler by the OXC team, used for MDX compilation
- Lightning CSS -- Rust CSS parser with a optimized JavaScript Visitor API
Sätteri is an open-source project born from Bruits, a Rust-focused collective 💛
Extension points exported contracts — how you extend this code
Plugin (Interface)
The Rust plugin trait. Implement only the visitor methods you need. Default implementations return NoChange (no-op) so [21 …
crates/satteri-plugin-api/src/plugin.rs
ParserCallbacks (Interface)
Trait to customize [`Parser`] behavior with callbacks. See [`Parser::new_with_callbacks`]. All methods have a default i [3 …
crates/satteri-pulldown-cmark/src/parse.rs
HastVisitorContext (Interface)
(no doc) [3 implementers]
packages/satteri/src/hast/hast-visitor.ts
ArenaKind (Interface)
(no doc) [2 implementers]
crates/satteri-arena/src/kind.rs
VitePluginSatteriOptions (Interface)
(no doc)
packages/vite-plugin-satteri/src/index.ts
OpCollector (Interface)
Per-kind hooks for [`replay_opstream`]. `Kind` ties a collector to one arena flavor, so a cross-kind replay stays a comp [2 …
crates/satteri-plugin-api/src/js_commands.rs
StubResolver (Interface)
The slice of `LazyChildResolver` a stub getter needs.
packages/satteri/src/child-stub.ts
StubHost (Interface)
Stub host shape: `_id`/`_resolver` are enumerable plain fields for * construction speed; spread/identity rules are enf
packages/satteri/src/child-stub.ts
Core symbols most depended-on inside this repo
push
called by 620
crates/satteri-pulldown-cmark/src/tree.rs
len
called by 488
crates/satteri-plugin-api/src/data.rs
assertMdastConformance
called by 448
packages/satteri/test/conformance/helpers.ts
close_node
called by 247
crates/satteri-arena/src/builder.rs
get_children
called by 237
crates/satteri-arena/src/arena.rs
as_bytes
called by 222
crates/satteri-arena/src/node.rs
len
called by 217
crates/satteri-arena/src/arena.rs
alloc_string
called by 210
crates/satteri-arena/src/arena.rs
Shape
Languages
Rust81%
TypeScript19%
Python1%
Modules by API surface
crates/satteri-pulldown-cmark/tests/suite/spec.rs652 symbols
crates/satteri-pulldown-cmark/tests/suite/regression.rs211 symbols
crates/satteri-pulldown-cmark/src/parse.rs151 symbols
crates/satteri-pulldown-cmark/tests/mdx.rs126 symbols
crates/satteri-pulldown-cmark/src/firstpass.rs106 symbols
crates/satteri-plugin-api/src/js_commands.rs94 symbols
crates/satteri-ast/src/convert.rs83 symbols
packages/satteri/src/hast/hast-visitor.ts74 symbols
crates/satteri-pulldown-cmark/src/scanners.rs74 symbols
crates/satteri-pulldown-cmark/tests/suite/math.rs72 symbols
crates/satteri-mdxjs-rs/tests/test.rs60 symbols
crates/satteri-ast/src/mdast/codec.rs59 symbols
Used by 1 indexed graphs manifest dependencies, hub-wide
For agents
$ claude mcp add satteri \
-- python -m otcore.mcp_server <graph>