diff options
Diffstat (limited to 'dlang/README.md')
| -rw-r--r-- | dlang/README.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/dlang/README.md b/dlang/README.md index bb0aefd..181d27f 100644 --- a/dlang/README.md +++ b/dlang/README.md @@ -1,7 +1,7 @@ # ssp-reader, in D Reader for the **`.ssp` document-abstraction text format** emitted -by [sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine). +by [sisudoc-spine](https://git.sisudoc.org/sisudoc-spine). Reads a `.ssp` file (spine's PEG-parsable serialisation of its internal document abstraction) and renders it into a chosen output: @@ -44,7 +44,7 @@ Spine's processing pipeline has three stages: `ssp-reader` picks up the abstraction at the end of stage 2 (the `.ssp` file) and runs alternative stage-3 renderings on top of it. The `.ssp` format itself is documented in -[`sisudoc-abstraction-format`](https://git.sisudoc.org/tools/sisudoc-abstraction-format). +[`sisudoc-abstraction-format`](https://git.sisudoc.org/sisudoc-abstraction-format). ## Quickstart @@ -127,7 +127,7 @@ the HTML, in the plain text, and as an embedding chunk in the JSONL. Fixed, and the reason the report exists. That is deliberate and is what makes the reader usable as a check on the -[format specification](https://git.sisudoc.org/specs/sisudoc-abstraction-format): +[format specification](https://git.sisudoc.org/sisudoc-abstraction-format): a reader that drops what it does not know is conforming, but one that cannot say what it dropped cannot tell you whether the specification it was written from was complete. Silence and understanding look alike otherwise. @@ -135,7 +135,7 @@ written from was complete. Silence and understanding look alike otherwise. ## Documentation - The `.ssp` format itself: see - [sisudoc-abstraction-format](https://git.sisudoc.org/tools/sisudoc-abstraction-format). + [sisudoc-abstraction-format](https://git.sisudoc.org/sisudoc-abstraction-format). - Source: [`src/`](src/) - one module per output format (`output_tree.d`, `output_html.d`, `output_llm_breadcrumbs.d`, `output_llm_jsonl.d`, `output_images.d`, `verify_images.d`), plus @@ -144,19 +144,19 @@ written from was complete. Silence and understanding look alike otherwise. ## License AGPL-3.0-or-later. See [`dub.json`](dub.json) and the parent -[sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine) +[sisudoc-spine](https://git.sisudoc.org/sisudoc-spine) project for full licence text. ## Repository -- **Canonical URL:** https://git.sisudoc.org/tools/sisudoc-ssp-reader +- **Canonical URL:** https://git.sisudoc.org/sisudoc-ssp-reader - **Clone:** `git clone --depth=1 git://git.sisudoc.org/tools/sisudoc-ssp-reader` ## Related projects -- [sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine) - +- [sisudoc-spine](https://git.sisudoc.org/sisudoc-spine) - produces the `.ssp` files this tool consumes. -- [sisudoc-abstraction-format](https://git.sisudoc.org/tools/sisudoc-abstraction-format) - +- [sisudoc-abstraction-format](https://git.sisudoc.org/sisudoc-abstraction-format) - specification of the `.ssp` text format. -- [tree-sitter-sisu](https://git.sisudoc.org/tools/tree-sitter-sisu) - +- [tree-sitter-sisu](https://git.sisudoc.org/tree-sitter-sisu) - tree-sitter grammar for the upstream `.sst` / `.ssm` markup. |
