Hello, 世界!
\n"); ``` @@ -153,7 +153,7 @@ Or you can parse the input into an AST yourself, manipulate it, and then use you ``` rust extern crate comrak; -use comrak::{parse_document, format_html, Arena, ComrakOptions}; +use comrak::{parse_document, format_html, Arena, Options}; use comrak::nodes::{AstNode, NodeValue}; // The returned nodes are created in the supplied Arena, and are bound by its lifetime. @@ -162,7 +162,7 @@ let arena = Arena::new(); let root = parse_document( &arena, "This is my input.\n\n1. Also my input.\n2. Certainly my input.\n", - &ComrakOptions::default()); + &Options::default()); fn iter_nodes<'a, F>(node: &'a AstNode<'a>, f: &F) where F : Fn(&'a AstNode<'a>) { @@ -183,7 +183,7 @@ iter_nodes(root, &|node| { }); let mut html = vec![]; -format_html(root, &ComrakOptions::default(), &mut html).unwrap(); +format_html(root, &Options::default(), &mut html).unwrap(); assert_eq!( String::from_utf8(html).unwrap(), @@ -224,7 +224,7 @@ Comrak additionally supports its own extensions, which are yet to be specced out - Shortcodes By default none are enabled; they are individually enabled with each parse by setting the appropriate values in the -[`ComrakOptions` struct](https://docs.rs/comrak/newest/comrak/struct.ComrakOptions.html). +[`Options` struct](https://docs.rs/comrak/newest/comrak/struct.Options.html). ## Plugins @@ -233,7 +233,7 @@ By default none are enabled; they are individually enabled with each parse by se At the moment syntax highlighting of codefence blocks is the only feature that can be enhanced with plugins. Create an implementation of the `SyntaxHighlighterAdapter` trait, and then provide an instance of such adapter to -`ComrakPlugins.render.codefence_syntax_highlighter`. For formatting a markdown document with plugins, use the +`Plugins.render.codefence_syntax_highlighter`. For formatting a markdown document with plugins, use the `markdown_to_html_with_plugins` function, which accepts your plugin as a parameter. See the `syntax_highlighter.rs` and `syntect.rs` examples for more details. @@ -242,7 +242,7 @@ See the `syntax_highlighter.rs` and `syntect.rs` examples for more details. [`syntect`](https://github.com/trishume/syntect) is a syntax highlighting library for Rust. By default, `comrak` offers a plugin for it. In order to utilize it, create an instance of `plugins::syntect::SyntectAdapter` and use it as your -`ComrakPlugins` option. +`Plugins` option. ## Related projects diff --git a/benches/progit.rs b/benches/progit.rs index 79963d86..b35cb695 100644 --- a/benches/progit.rs +++ b/benches/progit.rs @@ -2,7 +2,7 @@ extern crate test; -use comrak::{format_html, parse_document, Arena, ComrakOptions}; +use comrak::{format_html, parse_document, Arena, Options}; use test::Bencher; #[bench] @@ -15,8 +15,8 @@ fn bench_progit(b: &mut Bencher) { file.read_to_string(&mut s).unwrap(); b.iter(|| { let arena = Arena::new(); - let root = parse_document(&arena, &s, &ComrakOptions::default()); + let root = parse_document(&arena, &s, &Options::default()); let mut output = vec![]; - format_html(root, &ComrakOptions::default(), &mut output).unwrap() + format_html(root, &Options::default(), &mut output).unwrap() }); } diff --git a/examples/custom_headings.rs b/examples/custom_headings.rs index 7020cc09..2e4dc9ae 100644 --- a/examples/custom_headings.rs +++ b/examples/custom_headings.rs @@ -2,14 +2,14 @@ use comrak::{ adapters::{HeadingAdapter, HeadingMeta}, markdown_to_html_with_plugins, nodes::Sourcepos, - ComrakOptions, ComrakPlugins, + Options, Plugins, }; use std::io::{self, Write}; fn main() { let adapter = CustomHeadingAdapter; - let mut options = ComrakOptions::default(); - let mut plugins = ComrakPlugins::default(); + let mut options = Options::default(); + let mut plugins = Plugins::default(); plugins.render.heading_adapter = Some(&adapter); print_html( @@ -62,7 +62,7 @@ impl HeadingAdapter for CustomHeadingAdapter { } } -fn print_html(document: &str, options: &ComrakOptions, plugins: &ComrakPlugins) { +fn print_html(document: &str, options: &Options, plugins: &Plugins) { let html = markdown_to_html_with_plugins(document, options, plugins); println!("{}", html); } diff --git a/examples/headers.rs b/examples/headers.rs index 69b8df3d..d1cadfb4 100644 --- a/examples/headers.rs +++ b/examples/headers.rs @@ -2,7 +2,7 @@ use comrak::{ nodes::{AstNode, NodeCode, NodeValue}, - parse_document, Arena, ComrakOptions, + parse_document, Arena, Options, }; fn main() { @@ -13,7 +13,7 @@ fn main() { fn get_document_title(document: &str) -> String { let arena = Arena::new(); - let root = parse_document(&arena, document, &ComrakOptions::default()); + let root = parse_document(&arena, document, &Options::default()); for node in root.children() { let header = match node.data.clone().into_inner().value { diff --git a/examples/s-expr.rs b/examples/s-expr.rs index fa7af0cf..c8a1341b 100644 --- a/examples/s-expr.rs +++ b/examples/s-expr.rs @@ -14,7 +14,7 @@ const INDENT: usize = 4; const CLOSE_NEWLINE: bool = false; use comrak::nodes::{AstNode, NodeValue}; -use comrak::{parse_document, Arena, ComrakExtensionOptions, ComrakOptions}; +use comrak::{parse_document, Arena, ExtensionOptions, Options}; use std::env; use std::error::Error; use std::fs::File; @@ -74,8 +74,8 @@ fn iter_nodes<'a, W: Write>( fn dump(source: &str) -> io::Result<()> { let arena = Arena::new(); - let opts = ComrakOptions { - extension: ComrakExtensionOptions { + let opts = Options { + extension: ExtensionOptions { strikethrough: true, tagfilter: true, table: true, @@ -84,9 +84,9 @@ fn dump(source: &str) -> io::Result<()> { superscript: true, footnotes: true, description_lists: true, - ..ComrakExtensionOptions::default() + ..ExtensionOptions::default() }, - ..ComrakOptions::default() + ..Options::default() }; let doc = parse_document(&arena, source, &opts); diff --git a/examples/sample.rs b/examples/sample.rs index 552a5781..fb7b8148 100644 --- a/examples/sample.rs +++ b/examples/sample.rs @@ -1,17 +1,17 @@ // Samples used in the README. Wanna make sure they work as advertised. fn small() { - use comrak::{markdown_to_html, ComrakOptions}; + use comrak::{markdown_to_html, Options}; assert_eq!( - markdown_to_html("Hello, **世界**!", &ComrakOptions::default()), + markdown_to_html("Hello, **世界**!", &Options::default()), "Hello, 世界!
\n" ); } fn large() { use comrak::nodes::{AstNode, NodeValue}; - use comrak::{format_html, parse_document, Arena, ComrakOptions}; + use comrak::{format_html, parse_document, Arena, Options}; // The returned nodes are created in the supplied Arena, and are bound by its lifetime. let arena = Arena::new(); @@ -19,7 +19,7 @@ fn large() { let root = parse_document( &arena, "This is my input.\n\n1. Also my input.\n2. Certainly my input.\n", - &ComrakOptions::default(), + &Options::default(), ); fn iter_nodes<'a, F>(node: &'a AstNode<'a>, f: &F) @@ -40,7 +40,7 @@ fn large() { }); let mut html = vec![]; - format_html(root, &ComrakOptions::default(), &mut html).unwrap(); + format_html(root, &Options::default(), &mut html).unwrap(); assert_eq!( String::from_utf8(html).unwrap(), diff --git a/examples/syntax_highlighter.rs b/examples/syntax_highlighter.rs index 84a41ba2..f95806c9 100644 --- a/examples/syntax_highlighter.rs +++ b/examples/syntax_highlighter.rs @@ -1,7 +1,7 @@ //! This example shows how to implement a syntax highlighter plugin. use comrak::adapters::SyntaxHighlighterAdapter; -use comrak::{markdown_to_html_with_plugins, ComrakOptions, ComrakPlugins}; +use comrak::{markdown_to_html_with_plugins, Options, Plugins}; use std::collections::HashMap; use std::io::{self, Write}; @@ -59,8 +59,8 @@ impl SyntaxHighlighterAdapter for PotatoSyntaxAdapter { fn main() { let adapter = PotatoSyntaxAdapter::new(42); - let options = ComrakOptions::default(); - let mut plugins = ComrakPlugins::default(); + let options = Options::default(); + let mut plugins = Plugins::default(); plugins.render.codefence_syntax_highlighter = Some(&adapter); diff --git a/examples/syntect.rs b/examples/syntect.rs index 90222cd4..bf6e8c38 100644 --- a/examples/syntect.rs +++ b/examples/syntect.rs @@ -1,12 +1,12 @@ //! This example shows how to use the bundled syntect plugin. use comrak::plugins::syntect::SyntectAdapter; -use comrak::{markdown_to_html_with_plugins, ComrakOptions, ComrakPlugins}; +use comrak::{markdown_to_html_with_plugins, Options, Plugins}; fn main() { let adapter = SyntectAdapter::new("base16-ocean.dark"); - let options = ComrakOptions::default(); - let mut plugins = ComrakPlugins::default(); + let options = Options::default(); + let mut plugins = Plugins::default(); plugins.render.codefence_syntax_highlighter = Some(&adapter); diff --git a/examples/update-readme.rs b/examples/update-readme.rs index 483e7ec9..36316cb6 100644 --- a/examples/update-readme.rs +++ b/examples/update-readme.rs @@ -4,7 +4,7 @@ use std::fmt::Write; use std::str; use comrak::nodes::{AstNode, NodeValue}; -use comrak::{format_commonmark, parse_document, Arena, ComrakOptions}; +use comrak::{format_commonmark, parse_document, Arena, Options}; const DEPENDENCIES: &str = "[dependencies]\ncomrak = "; const HELP: &str = "$ comrak --help\n"; @@ -13,7 +13,7 @@ fn main() -> Result<(), BoxHello, 世界!
\n"); //! ``` //! @@ -16,7 +16,7 @@ //! formatter: //! //! ``` -//! use comrak::{Arena, parse_document, format_html, ComrakOptions}; +//! use comrak::{Arena, parse_document, format_html, Options}; //! use comrak::nodes::{AstNode, NodeValue}; //! //! # fn main() { @@ -26,7 +26,7 @@ //! let root = parse_document( //! &arena, //! "This is my input.\n\n1. Also my input.\n2. Certainly my input.\n", -//! &ComrakOptions::default()); +//! &Options::default()); //! //! fn iter_nodes<'a, F>(node: &'a AstNode<'a>, f: &F) //! where F : Fn(&'a AstNode<'a>) { @@ -47,7 +47,7 @@ //! }); //! //! let mut html = vec![]; -//! format_html(root, &ComrakOptions::default(), &mut html).unwrap(); +//! format_html(root, &Options::default(), &mut html).unwrap(); //! //! assert_eq!( //! String::from_utf8(html).unwrap(), @@ -100,29 +100,37 @@ pub use html::format_document as format_html; pub use html::format_document_with_plugins as format_html_with_plugins; pub use html::Anchorizer; pub use parser::{ - parse_document, parse_document_with_broken_link_callback, ComrakExtensionOptions, - ComrakOptions, ComrakParseOptions, ComrakPlugins, ComrakRenderOptions, ComrakRenderPlugins, - ListStyleType, + parse_document, parse_document_with_broken_link_callback, ExtensionOptions, ListStyleType, + Options, ParseOptions, Plugins, RenderOptions, RenderPlugins, }; pub use typed_arena::Arena; pub use xml::format_document as format_xml; pub use xml::format_document_with_plugins as format_xml_with_plugins; +/// Legacy naming of [`ExtensionOptions`] +pub type ComrakExtensionOptions = ExtensionOptions; +/// Legacy naming of [`Options`] +pub type ComrakOptions = Options; +/// Legacy naming of [`ParseOptions`] +pub type ComrakParseOptions = ParseOptions; +/// Legacy naming of [`Plugins`] +pub type ComrakPlugins<'a> = Plugins<'a>; +/// Legacy naming of [`RenderOptions`] +pub type ComrakRenderOptions = RenderOptions; +/// Legacy naming of [`RenderPlugins`] +pub type ComrakRenderPlugins<'a> = RenderPlugins<'a>; + /// Render Markdown to HTML. /// /// See the documentation of the crate root for an example. -pub fn markdown_to_html(md: &str, options: &ComrakOptions) -> String { - markdown_to_html_with_plugins(md, options, &ComrakPlugins::default()) +pub fn markdown_to_html(md: &str, options: &Options) -> String { + markdown_to_html_with_plugins(md, options, &Plugins::default()) } /// Render Markdown to HTML using plugins. /// /// See the documentation of the crate root for an example. -pub fn markdown_to_html_with_plugins( - md: &str, - options: &ComrakOptions, - plugins: &ComrakPlugins, -) -> String { +pub fn markdown_to_html_with_plugins(md: &str, options: &Options, plugins: &Plugins) -> String { let arena = Arena::new(); let root = parse_document(&arena, md, options); let mut bw = BufWriter::new(Vec::new()); @@ -136,7 +144,7 @@ pub fn version() -> &'static str { } /// Render Markdown back to CommonMark. -pub fn markdown_to_commonmark(md: &str, options: &ComrakOptions) -> String { +pub fn markdown_to_commonmark(md: &str, options: &Options) -> String { let arena = Arena::new(); let root = parse_document(&arena, md, options); let mut bw = BufWriter::new(Vec::new()); @@ -146,16 +154,16 @@ pub fn markdown_to_commonmark(md: &str, options: &ComrakOptions) -> String { /// Render Markdown to CommonMark XML. /// See https://github.com/commonmark/commonmark-spec/blob/master/CommonMark.dtd. -pub fn markdown_to_commonmark_xml(md: &str, options: &ComrakOptions) -> String { - markdown_to_commonmark_xml_with_plugins(md, options, &ComrakPlugins::default()) +pub fn markdown_to_commonmark_xml(md: &str, options: &Options) -> String { + markdown_to_commonmark_xml_with_plugins(md, options, &Plugins::default()) } /// Render Markdown to CommonMark XML using plugins. /// See https://github.com/commonmark/commonmark-spec/blob/master/CommonMark.dtd. pub fn markdown_to_commonmark_xml_with_plugins( md: &str, - options: &ComrakOptions, - plugins: &ComrakPlugins, + options: &Options, + plugins: &Plugins, ) -> String { let arena = Arena::new(); let root = parse_document(&arena, md, options); diff --git a/src/main.rs b/src/main.rs index 0fa92fbd..8595f8bc 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,9 +1,8 @@ //! The `comrak` binary. use comrak::{ - adapters::SyntaxHighlighterAdapter, plugins::syntect::SyntectAdapter, Arena, - ComrakExtensionOptions, ComrakOptions, ComrakParseOptions, ComrakPlugins, ComrakRenderOptions, - ListStyleType, + adapters::SyntaxHighlighterAdapter, plugins::syntect::SyntectAdapter, Arena, ExtensionOptions, + ListStyleType, Options, ParseOptions, Plugins, RenderOptions, }; use std::boxed::Box; use std::env; @@ -195,8 +194,8 @@ fn main() -> Result<(), BoxWow look at this cool \
/// link. \
@@ -93,7 +93,7 @@ pub fn parse_document<'a>(
pub fn parse_document_with_broken_link_callback<'a, 'c>(
arena: &'a Arena Hello world there.