https://github.com/tamschi/lignin-html
HTML renderer for `lignin` VDOM Nodes.
https://github.com/tamschi/lignin-html
hacktoberfest html platform-agnostic renderer-backend rust
Last synced: 3 months ago
JSON representation
HTML renderer for `lignin` VDOM Nodes.
- Host: GitHub
- URL: https://github.com/tamschi/lignin-html
- Owner: Tamschi
- License: other
- Created: 2020-10-02T18:06:28.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-12T11:48:15.000Z (about 1 year ago)
- Last Synced: 2025-02-28T13:51:52.563Z (3 months ago)
- Topics: hacktoberfest, html, platform-agnostic, renderer-backend, rust
- Language: Rust
- Homepage:
- Size: 145 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# lignin-html
[](https://lib.rs/crates/lignin-html)
[](https://crates.io/crates/lignin-html)
[](https://docs.rs/lignin-html)
[](https://github.com/Tamschi/lignin-html/actions?query=workflow%3ACI+branch%3Adevelop)
[](https://github.com/Tamschi/lignin-html)
[](https://github.com/Tamschi/lignin-html/issues)
[](https://github.com/Tamschi/lignin-html/pulls)
[](https://github.com/Tamschi/lignin-html/contribute)
[](https://web.crev.dev/rust-reviews/crate/lignin-html/)
[](https://iteration-square.schichler.dev/#narrow/stream/project.2Flignin-html)
HTML renderer for [lignin] VDOM Nodes.
This crate is primarily for static and server-side rendering.
For client-side use, see [lignin-dom].
[lignin]: https://github.com/Tamschi/lignin
[lignin-dom]: https://github.com/Tamschi/lignin-dom
## Installation
Please use [cargo-edit](https://crates.io/crates/cargo-edit) to always add the latest version of this library:
```cmd
cargo add lignin-html
```
## Example
```rust
use lignin::{Node, Element, ElementCreationOptions};
use lignin_html::render_document;
let mut document = String::new();
render_document(
&Node::HtmlElement {
element: &Element {
// `lignin-html` is case-preserving but insensitive.
// `lignin-dom` slightly prefers all-caps, as may other DOM renderers.¹
name: "DIV",
creation_options: ElementCreationOptions::new(), // `const fn` builder pattern.
attributes: &[],
content: Node::Multi(&[
"Hello! ".into(),
Node::Comment {
// `lignin-html` escapes or substitutes where necessary and unobtrusive.
comment: "--> Be mindful of HTML pitfalls. ",
);
```
¹ See [Element.tagName (MDN)](https://developer.mozilla.org/en-US/docs/Web/API/Element/tagName). This avoids case-insensitive comparisons, but can cause elements to be recreated during hydration if the reported ***tagName*** doesn't quite match the generated `name`.
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
## [Code of Conduct](CODE_OF_CONDUCT.md)
## [Changelog](CHANGELOG.md)
## Versioning
`lignin-html` strictly follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) with the following exceptions:
- The minor version will not reset to 0 on major version changes (except for v1).
Consider it the global feature level.
- The patch version will not reset to 0 on major or minor version changes (except for v0.1 and v1).
Consider it the global patch level.
This includes the Rust version requirement specified above.
Earlier Rust versions may be compatible, but this can change with minor or patch releases.
Which versions are affected by features and patches can be determined from the respective headings in [CHANGELOG.md](CHANGELOG.md).
Note that dependencies of this crate may have a more lenient MSRV policy!
Please use `cargo +nightly update -Z minimal-versions` in your automation if you don't generate Cargo.lock manually (or as necessary) and require support for a compiler older than current stable.