diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 21 insertions, 9 deletions
@@ -1,7 +1,16 @@ # tree-sitter-sisu -Tree-sitter grammar for **SiSU spine** document markup (`.sst`, `.ssm`, -`.ssi`). +Tree-sitter grammar for **SiSU markup** (`.sst`, `.ssm`, `.ssi`), +covering both header dialects of the SiSU family: + +- **Bespoke / original SiSU** headers: `@title:`, `@creator:`, with + ` :sub-key:` continuation lines and `%` line comments throughout. +- **YAML / sisudoc-spine** headers: yaml mapping, with `#` line + comments in the header and `%` line comments in the body. + +The two body grammars are identical; only the header preamble +differs. A document picks one header dialect; mixing both inside +the same file is parseable but not idiomatic. Provides structural syntax highlighting, folding, and text-object queries for any editor that hosts a tree-sitter runtime: Neovim, @@ -25,15 +34,18 @@ support inside their editor. Not aimed at end-user document authors directly; it is consumed via your editor's tree-sitter integration. -## Relationship to spine +## Relationship to spine and to original sisu -This grammar parses the same input syntax as +This grammar parses the input syntax shared by [sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine) -itself. Spine produces the canonical parse used for output -generation; this grammar provides editor-side parsing for -highlighting and navigation, and is kept in sync with spine's -markup rules. See [`sisu-markup_tree-sitter.md`](sisu-markup_tree-sitter.md) -for the corpus-level test results and known limitations. +(yaml headers) and the original +[sisu](https://sisudoc.org/projects/sisu/) tool (bespoke headers). +Bodies are the same. Spine produces the canonical parse used for +output generation; this grammar provides editor-side parsing for +highlighting and navigation, and is kept in sync with the markup +rules of both tools. See +[`sisu-markup_tree-sitter.md`](sisu-markup_tree-sitter.md) for the +corpus-level test results and known limitations. ## Quickstart |