bezel-markdown 0.2.5

A Notion-style block document model for gpui — markdown in, markdown out
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

//! A Notion-style block document model, with markdown as the wire form.
//!
//! ```
//! let doc = markdown::parse("# Title\n\n- a\n- b");
//! assert_eq!(doc.blocks.len(), 3);
//! assert_eq!(markdown::serialize(&doc), "# Title\n\n- a\n- b");
//! ```
//!
//! The model is a flat list of blocks with an indent level ([`Doc`]), not a
//! nested tree — Notion's shape rather than CommonMark's, chosen because
//! editing a flat list is list operations while editing a tree is restructuring.
//! [`parse`] and [`serialize`] are inverses up to a fixed point: parsing,
//! serializing and parsing again always lands on the same document, so an
//! edit/save cycle cannot drift.
//!
//! [`doc`], [`parse`], [`serialize`], [`select`] and [`edit`] are pure — no
//! gpui, no painting — and [`render`] is the gpui layer over them, caret and
//! selection included for a caller that owns them. The editing *surface* is the
//! `editor` crate.
//!
//! An image at an `http` URL — a picture, a favicon, a bookmark's cover —
//! needs an http client on the app, which `gpui_platform::application` installs
//! and a hand-built [`gpui::Application`] does not. gpui's own default is a
//! `NullHttpClient`, and the failure is silent: the element paints the same
//! fallback it would show while a fetch was still in flight.

mod app;
pub use app::AppExt;

pub mod block;
pub mod doc;
pub mod edit;
pub mod find;
pub mod highlight;
pub mod layout;
pub mod link;
pub mod marks;
pub mod parse;
pub mod preview;
pub mod quote;
pub mod render;
pub mod select;
pub mod selectable;
pub mod serialize;
pub mod source;
pub mod source_style;
pub mod typography;

pub use block::BlockRenderer;
pub use doc::{Align, Block, BlockKind, Doc, Form, Mark, MarkSpan, Part, QuoteKind, Text};
pub use edit::{Shortcut, Splice, shortcut};
pub use find::{FindPaint, default_find};
pub use highlight::Highlighter;
pub use layout::Layout;
pub use link::LinkHandler;
pub use marks::{
    HighlightColor, HighlightPaint, MarkPaint, Marks, default_highlight, highlight_solid,
};
pub use parse::{ParsedDoc, is_image, is_url, parse, parse_at, parse_ranges, parse_with};
pub use preview::{LinkPreview, Preview};
pub use quote::Quote;
pub use render::{
    Annotation, BlockLayouts, Caption, CopyButton, Editing, ImageOverlay, ImageOverlayCorner,
    OnImage, OnToggle, Toggle, image_source, markdown, render, render_source, render_with,
};
pub use select::{Cursor, Selection};
pub use serialize::{serialize, serialize_at, serialize_with};
pub use source::spans as source_spans;
pub use source_style::SourceStyle;
pub use typography::Typography;