From 2634a083a58e15935ce57eb0077f736309e78aae Mon Sep 17 00:00:00 2001 From: Philipp A Date: Wed, 8 Jan 2020 20:13:56 +0100 Subject: Added READMEs --- renderer/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 renderer/README.md (limited to 'renderer/README.md') diff --git a/renderer/README.md b/renderer/README.md new file mode 100644 index 0000000..69aa1ec --- /dev/null +++ b/renderer/README.md @@ -0,0 +1,16 @@ +`rst_renderer` +============== + +Part of the [`rst`][rst] crate family. +This crate contains the HTML renderer (which supports most of what the parser supports), +as well as the broken XML and JSON renderers. +Suggestions and PRs welcome on how to get them right! + +```rust +let document = Document::with_children(vec![...]); // or rst_parser::parse() +let stream = std::io::stdout(); +let standalone = true; // wrap in +render_html(document, stream, standalone); +``` + +[rst]: https://github.com/flying-sheep/rust-rst/#readme -- cgit v1.2.3