mdwright-document 0.1.0

Recognised Markdown document facts with stable source coordinates
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# mdwright-document

[![docs.rs](https://docs.rs/mdwright-document/badge.svg)](https://docs.rs/mdwright-document)

Recognised Markdown document facts with stable source coordinates, for
[mdwright](https://github.com/jcreinhold/mdwright).

This crate owns Markdown parsing for the whole workspace. It invokes pulldown-cmark
behind a containment boundary that catches the parser's known panics on malformed
input and turns them into structured errors, and produces typed `Document` facts:
headings, list groups, link definitions, frontmatter, code/HTML exclusions, inline
atoms, wrappable paragraphs, table sites, and the structural ranges the formatter
rewrites against. Every downstream crate (`mdwright-format`,
`mdwright-lint`, `mdwright-config`) consumes these facts; none of them sees
pulldown events directly.

Bytes-in / facts-out is the entire contract. Formatting decisions, lint rules, and
configuration policy belong to the other crates.

## Status

Pre-1.0. Public items are whatever `lib.rs` re-exports; breaking changes ship
without deprecation warnings.

## Use it

```toml
[dependencies]
mdwright-document = "0.1"
```

```rust
use mdwright_document::Document;
```

## See also

- Project: <https://github.com/jcreinhold/mdwright>
- Library walkthrough: <https://jcreinhold.github.io/mdwright/reference/public-api.html#use-mdwright-as-a-library>
- Manual: <https://jcreinhold.github.io/mdwright/>
- Architecture: `docs/architecture/parser-boundary.md`,
  `docs/architecture/crate-boundaries.md`

## License

Licensed under MIT or Apache-2.0, at your option.