pub struct Document {
pub html: String,
pub metadata: HashMap<String, String>,
pub metadata_raw: HashMap<String, Value>,
pub toc: String,
pub toc_html: String,
pub toc_tree: Vec<TocItem>,
pub headings: Vec<Heading>,
pub reading_time: usize,
}Expand description
Markdownドキュメントの解析結果
Fields§
§html: StringHTML出力
metadata: HashMap<String, String>frontmatterメタデータ
metadata_raw: HashMap<String, Value>型を保持したfrontmatterメタデータ
toc: String目次(Markdown形式)
toc_html: String目次(HTML形式)
toc_tree: Vec<TocItem>階層化された目次
headings: Vec<Heading>見出し一覧
reading_time: usize読了時間(分)
Implementations§
Source§impl Document
impl Document
Sourcepub fn parse(markdown: &str) -> Self
pub fn parse(markdown: &str) -> Self
Markdownをパースして構造化データを返す
§例
use mdja::Document;
let doc = Document::parse("# Hello\n\nこんにちは");
assert!(doc.html.contains("<h1"));
assert_eq!(doc.headings.len(), 1);Sourcepub fn parse_with_options(markdown: &str, options: &ParseOptions) -> Self
pub fn parse_with_options(markdown: &str, options: &ParseOptions) -> Self
Markdownを指定オプションでパースして構造化データを返す
Sourcepub fn to_html(markdown: &str) -> String
pub fn to_html(markdown: &str) -> String
シンプルなHTML変換(メタデータ不要な場合)
§例
use mdja::Document;
let html = Document::to_html("**太字**");
assert!(html.contains("<strong>"));Sourcepub fn to_html_with_options(markdown: &str, options: &ParseOptions) -> String
pub fn to_html_with_options(markdown: &str, options: &ParseOptions) -> String
指定オプションでMarkdownをHTMLに変換する
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Document
impl<'de> Deserialize<'de> for Document
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for Document
impl RefUnwindSafe for Document
impl Send for Document
impl Sync for Document
impl Unpin for Document
impl UnsafeUnpin for Document
impl UnwindSafe for Document
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more