Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cobalt-org/liquid-rust
Liquid templating for Rust
https://github.com/cobalt-org/liquid-rust
liquid rust template-language
Last synced: 2 days ago
JSON representation
Liquid templating for Rust
- Host: GitHub
- URL: https://github.com/cobalt-org/liquid-rust
- Owner: cobalt-org
- License: mit
- Created: 2014-11-09T08:29:49.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T01:17:17.000Z (7 months ago)
- Last Synced: 2024-04-23T23:53:37.963Z (7 months ago)
- Topics: liquid, rust, template-language
- Language: Rust
- Homepage: docs.rs/liquid
- Size: 2.22 MB
- Stars: 430
- Watchers: 9
- Forks: 74
- Open Issues: 80
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
liquid-rust
===========
> [Liquid templating](https://shopify.github.io/liquid/) for Rust
[](https://crates.io/crates/liquid)
Goals:
1. Conformant. Incompatibilities with [strict shopify/liquid][shopify-liquid] are [bugs to be fixed][shopify-compat].
2. Flexible. Liquid embraces [variants][liquid-variants] for different domains and we want to follow in that spirit.
3. Performant. Do the best we can within what is conformant.
[shopify-liquid]: https://github.com/Shopify/liquid
[shopify-compat]: https://github.com/cobalt-org/liquid-rust/labels/shopify-compatibility
[liquid-variants]: https://shopify.github.io/liquid/basics/variations/
Example applications using liquid-rust:
- [cobalt]: static site generator.
- [cargo-tarball]: crate bin packaging tool.
- [cargo-generate]: crate generator from templates.
- [Mandy]: A hypersonic, easy-to-use, performant static-site generator.
[cobalt]: https://cobalt-org.github.io/
[cargo-tarball]: https://github.com/crate-ci/cargo-tarball
[cargo-generate]: https://github.com/ashleygwilliams/cargo-generate
[Mandy]: https://github.com/alyxshang/mandy
Usage
----------
To include liquid in your project add the following to your Cargo.toml:
```console
$ cargo add liquid
```
Example:
```rust
let template = liquid::ParserBuilder::with_stdlib()
.build().unwrap()
.parse("Liquid! {{num | minus: 2}}").unwrap();
let globals = liquid::object!({
"num": 4f64
});
let output = template.render(&globals).unwrap();
assert_eq!(output, "Liquid! 2".to_string());
```
You can find a reference on Liquid syntax [here](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers).
Customizing Liquid
------------------
### Language Variants
By default, `liquid-rust` has no filters, tags, or blocks. You can enable the
default set or pick and choose which to add to suite your application.
### Create your own filters
Creating your own filters is very easy. Filters are simply functions or
closures that take an input `Value` and a `Vec` of optional arguments
and return a `Value` to be rendered or consumed by chained filters.
See
[filters/](https://github.com/cobalt-org/liquid-rust/blob/master/crates/lib/src/stdlib/filters)
for what a filter implementation looks like. You can then register it by
calling `liquid::ParserBuilder::filter`.
### Create your own tags
Tags are made up of two parts, the initialization and the rendering.
Initialization happens when the parser hits a Liquid tag that has your
designated name. You will have to specify a function or closure that will
then return a `Renderable` object to do the rendering.
See
[include_tag.rs](https://github.com/cobalt-org/liquid-rust/blob/master/crates/lib/src/stdlib/tags/include_tag.rs)
for what a tag implementation looks like. You can then register it by calling `liquid::ParserBuilder::tag`.
### Create your own tag blocks
Blocks work very similar to Tags. The only difference is that blocks contain other
markup, which is why block initialization functions take another argument, a list
of `Element`s that are inside the specified block.
See
[comment_block.rs](https://github.com/cobalt-org/liquid-rust/blob/master/crates/lib/src/stdlib/blocks/comment_block.rs)
for what a block implementation looks like. You can then register it by
calling `liquid::ParserBuilder::block`.