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
//! # peisar
//!
//! `peisar` is a practical Markdown parser written in Rust and exposed to
//! Node.js through napi-rs. It parses Markdown (with GFM and Kramdown
//! extensions) into a typed AST, renders that AST to HTML, and extracts YAML
//! front matter.
//!
//! ## Layout
//!
//! - [`frontmatter`] — YAML front-matter extraction (`--- … ---` blocks).
//! - [`cache`] — the [`PeisarCache`](cache::PeisarCache) in-memory + on-disk
//! file cache with file-watching, exported to JavaScript for
//! the `peisar-ssg` package.
//! - [`markdown`] — the Markdown pipeline:
//! - [`markdown::ast`] — the AST (`Block` / `Inline` tokens, options,
//! parsers, visitor, hooks), plus the JS-interop layer.
//! - [`markdown::config`] — the JavaScript-facing
//! [`PeisarOptions`](markdown::config::PeisarOptions) that combine AST
//! and render options.
//! - [`markdown::html`] — AST → HTML rendering.
//! - [`markdown::peisar`] — the `Peisar` class exported to JavaScript.
//!
//! ## Quick start (Rust)
//!
//! Parse Markdown into a [`Document`](markdown::ast::Document) and render it
//! to an HTML fragment:
//!
//! ```
//! use peisar::markdown::ast::{AstOptions, Document};
//! use peisar::markdown::html::{RenderOptions, render_document_html};
//!
//! let doc = Document::parse("# Hello **world**\n", &AstOptions::default(), None);
//! let html = render_document_html(
//! &doc,
//! Some(RenderOptions { fragment: true, ..RenderOptions::default() }),
//! );
//! assert_eq!(html, "<h1>Hello <strong>world</strong></h1>\n");
//! ```
//!
//! Extract YAML front matter from a document:
//!
//! ```
//! use peisar::frontmatter::frontmatter;
//!
//! let parsed = frontmatter("---\ntitle: Hello\n---\n\n# Hello".to_string()).unwrap();
//! assert_eq!(parsed.pure_markdown_content(), "# Hello");
//! assert_eq!(parsed.yaml_data().unwrap()["title"], "Hello");
//! ```
//!
//!
//! ## JavaScript surface
//!
//! The crate also compiles as a native addon. JS consumers construct
//! [`Peisar`](markdown::peisar::Peisar) with Markdown plus options and read
//! its `ast`, `html`, `frontmatter`, or `astJson` properties.
//! [`PeisarCache`](cache::PeisarCache) caches the Markdown and asset files of
//! a site directory in memory (and under `.peisar_cache`), exposes
//! `markdownFiles()`, `assetFiles()`, `listFiles()`, `getText()`, and
//! `getBinary()`, and can keep itself in sync with the filesystem via
//! `startWatchingJs()`; see the `peisar` npm package for the binding surface.