tdoc 0.12.0

Library and CLI for reading, rendering, and converting text documents across Markdown, HTML, Gemini, and FTML
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

//! tdoc is a toolkit for building, parsing, formatting, and exporting documents
//! across FTML, HTML, Markdown, and Gemini.
//!
//! The crate is centered around three core concepts:
//! - [`Document`], [`Paragraph`], and [`Span`], which form an in-memory tree
//!   representation of document content.
//! - Format modules (see [`ftml`], [`html`], [`markdown`], and [`gemini`]) that
//!   provide both parsers and writers for each external format.
//! - A [`formatter`] for rendering the tree to richly styled terminal output.
//!
//! Checklists (Markdown `- [ ]` entries or HTML `<input type="checkbox">`
//! lists) map to [`ParagraphType::Checklist`] nodes that store [`ChecklistItem`]
//! children. Nested checklist items are preserved end-to-end so complex task
//! hierarchies round-trip across every parser and writer.
//!
//! Definition lists (HTML `<dl>`, or the PHP Markdown Extra `Term` / `:
//! definition` syntax) map to [`ParagraphType::DefinitionList`] nodes holding
//! [`DefinitionItem`] children, each pairing one or more terms with a single
//! definition made of block paragraphs. Unlike checklists, they do not survive
//! every format: FTML and Gemtext have no such element, so those writers
//! flatten the structure into text, and Markdown cannot express several terms
//! sharing one definition. See the
//! [README](https://github.com/roblillack/tdoc#definition-lists) for what each
//! writer does.
//!
//! Most applications start by building a [`Document`] manually or converting
//! some source text via one of the format modules, manipulate or inspect the
//! tree, and finally render it with [`ftml::Writer`], [`html::Writer`], or
//! [`formatter::Formatter`].

mod macros;

pub mod document;
pub mod formatter;
pub mod ftml;
pub mod gemini;
pub mod html;
pub mod inline;
pub mod markdown;
pub mod metadata;
pub mod pager;
pub mod paragraph;
pub mod test_helpers;

pub use document::Document;
pub use inline::{InlineStyle, Span};
pub use pager::*;
pub use paragraph::{ChecklistItem, DefinitionItem, Paragraph, ParagraphType, TableCell, TableRow};

/// Convenience result type used across parsing and writing APIs.
pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;