diff options
Diffstat (limited to 'renderer')
| -rw-r--r-- | renderer/Cargo.toml | 5 | ||||
| -rw-r--r-- | renderer/README.md | 16 |
2 files changed, 19 insertions, 2 deletions
diff --git a/renderer/Cargo.toml b/renderer/Cargo.toml index c53c53f..051d175 100644 --- a/renderer/Cargo.toml +++ b/renderer/Cargo.toml @@ -5,10 +5,11 @@ authors = ['Philipp A. <flying-sheep@web.de>'] edition = '2018' description = 'a reStructuredText renderer' license = 'MIT OR Apache-2.0' +readme = 'README.md' -documentation = 'https://flying-sheep.github.io/rust-rst' +documentation = 'https://docs.rs/rst_renderer' homepage = 'https://github.com/flying-sheep/rust-rst' -repository = 'https://github.com/flying-sheep/rust-rst.git' +repository = 'https://github.com/flying-sheep/rust-rst' [dependencies] document_tree = { path = '../document_tree', version = '0.3.0' } 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 |