markdown-syntax 0.8.0

no_std + alloc Markdown syntax parser and serializer
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

#![doc = include_str!("../README.md")]
#![no_std]
#![deny(missing_docs)]

extern crate alloc;

mod compare;
mod decode;
mod entities;
mod gemoji;
mod leaves;
mod memo;
#[cfg(test)]
mod test_support;
mod unicode_cjk;
mod unicode_letters;
mod unicode_punctuation;

pub mod ast;
pub mod diagnostic;
#[cfg(feature = "html")]
pub mod html;
pub mod parse;
pub mod serialize;
pub mod span;
pub mod validate;

pub use ast::*;
pub use diagnostic::{Diagnostic, DiagnosticCode, DiagnosticSeverity};
#[cfg(feature = "html")]
pub use html::{HtmlError, HtmlOptions, SafeRawHtmlForm, TasklistAttrOrder};
pub use parse::{
    parse, parse_inline, Definitions, InlineOutput, InlineSource, InlineToken, ParseOutput,
    TokenRole,
};
pub use serialize::{BulletMarker, LineEnding, OrderedDelimiter, SerializeError, SerializeOptions};
pub use span::{LineIndex, LinePosition, Span};

/// Not part of the public API: the tree comparison that round-trip checks use,
/// exported so the crate's integration tests compare trees the same way.
#[doc(hidden)]
pub mod __private {
    pub use crate::compare::normalized_blocks;
    pub use crate::parse::inline_spans_to_source;

    /// How many top-level blocks `to_markdown` writes canonically because,
    /// written partly from the source, they would read back as something
    /// else.
    pub fn rewritten_blocks(document: &crate::Document) -> usize {
        document
            .write(&crate::SerializeOptions::default())
            .map_or(0, |(_, rewritten)| rewritten)
    }
}

/// Common imports for working with `markdown-syntax`: `use
/// markdown_syntax::prelude::*;` brings the AST, diagnostics, the parse
/// entry points, and serialize/span types (plus the HTML renderer under the
/// `html` feature) into scope.
pub mod prelude {
    pub use crate::ast::*;
    pub use crate::diagnostic::{Diagnostic, DiagnosticCode, DiagnosticSeverity};
    #[cfg(feature = "html")]
    pub use crate::html::{HtmlError, HtmlOptions, SafeRawHtmlForm, TasklistAttrOrder};
    pub use crate::parse::{
        parse, parse_inline, Definitions, InlineOutput, InlineSource, InlineToken, ParseOutput,
        TokenRole,
    };
    pub use crate::serialize::{
        BulletMarker, LineEnding, OrderedDelimiter, SerializeError, SerializeOptions,
    };
    pub use crate::span::{LineIndex, LinePosition, Span};
}