diff options
| author | Philipp A | 2020-01-08 20:13:56 +0100 |
|---|---|---|
| committer | Philipp A | 2020-01-08 20:13:56 +0100 |
| commit | 2634a083a58e15935ce57eb0077f736309e78aae (patch) | |
| tree | 73324f7255a960218e3648ce1b8703ac7af7b45a /renderer/README.md | |
| parent | 06e7d81088e33d7ee03e7088e1ec2289e9c2bf5c (diff) | |
| download | rust-rst-2634a083a58e15935ce57eb0077f736309e78aae.tar.bz2 | |
Added READMEs
Diffstat (limited to 'renderer/README.md')
| -rw-r--r-- | renderer/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
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 <!doctype html><html></html> +render_html(document, stream, standalone); +``` + +[rst]: https://github.com/flying-sheep/rust-rst/#readme |