https://github.com/dotliquid/dotliquid
.NET Port of Tobias Lütke's Liquid template language.
https://github.com/dotliquid/dotliquid
Last synced: 4 days ago
JSON representation
.NET Port of Tobias Lütke's Liquid template language.
- Host: GitHub
- URL: https://github.com/dotliquid/dotliquid
- Owner: dotliquid
- License: apache-2.0
- Created: 2010-08-19T01:50:46.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T14:26:26.000Z (13 days ago)
- Last Synced: 2025-04-04T08:57:32.605Z (11 days ago)
- Language: C#
- Homepage: https://www.dotliquid.org
- Size: 9.57 MB
- Stars: 1,069
- Watchers: 53
- Forks: 296
- Open Issues: 55
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.markdown
- Contributing: contributing.md
- License: LICENSE.txt
Awesome Lists containing this project
- Awesome-Nuget-Packages - **DotLiquid**
README
# DotLiquid
[](https://stackoverflow.com/questions/tagged/dotliquid)
[](https://ci.appveyor.com/project/microalps/dotliquid/branch/master)
[](https://codecov.io/gh/dotliquid/dotliquid)
[](https://www.nuget.org/packages/dotliquid)
[](https://gitter.im/dotliquid/dotliquid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Maintainers wanted
Have you sent a PR to this repository? In that case, would you consider getting
in touch with me so I can give you commit access to this repository? Please ping
me at [gitter/dotliquid](https://gitter.im/dotliquid/dotliquid) or here on
github.
### What is this?
DotLiquid is a .Net port of the popular [Ruby Liquid templating
language](https://shopify.github.io/liquid/). It is a separate project that aims to
retain the same template syntax as the original, while using .NET coding
conventions where possible.
For more information about the original Liquid project, see
.
### Quick start
1. Download the latest release from [NuGet](https://www.nuget.org/packages/dotliquid).
2. Read the [docs](//github.com/dotliquid/dotliquid/wiki) for information
on writing and using DotLiquid templates.
### Why should I use DotLiquid?
* You want to leave business logic in your compiled controllers and out of your templates.
* You're looking for a logic-less template language that also exists for other platforms (ie: node, python).
* You want to allow your users to edit their own page templates, but want to
ensure they don't run insecure code.
* You want to render templates directly from the database.
* You want a template engine for emails.
### What does it look like?
``` liquid
-
{{product.name}}
Only {{product.price | price }}{{product.description | prettyprint | paragraph }}
{% for product in products %}
{% endfor %}
```
### How to use DotLiquid
DotLiquid supports a very simple API based around the DotLiquid.Template class.
Generally, you can read the contents of a file into a template, and then render
the template by passing it parameters in the form of a `Hash` object. There are
several ways you can construct a `Hash` object, including from a Dictionary, or
using the `Hash.FromAnonymousObject` method.
```c#
Template template = Template.Parse("hi {{name}}"); // Parses and compiles the template
template.Render(Hash.FromAnonymousObject(new { name = "tobi" })); // => "hi tobi"
```
### Projects using DotLiquid
Are you using DotLiquid in an open source project? Tell us with a PR!
- [Suave.DotLiquid](https://github.com/SuaveIO/suave#introduction)
- [Pretzel](https://github.com/Code52/Pretzel)
- [Docfx](https://github.com/dotnet/docfx)
- [DotLiquid.Mailer](https://github.com/miseeger/DotLiquid.Mailer)
- [DotLiquid Template Engine for Suave.IO](https://www.nuget.org/packages/Suave.DotLiquid/)
- [DotLiquid Template Engine for Giraffe](https://github.com/giraffe-fsharp/Giraffe.DotLiquid)
- [DotLiquid View Engine for ASP.NET MVC](https://www.nuget.org/packages/DotLiquid.ViewEngine)
- [DotLiquid View Engine for Nancy](https://www.nuget.org/packages/Nancy.Viewengines.DotLiquid)
- [GrandNode 2.0](https://github.com/grandnode/grandnode2)
### License
DotLiquid is intended to be used in both open-source and commercial environments. To allow its use in as many
situations as possible, DotLiquid is dual-licensed. You may choose to use DotLiquid under either the [Apache License,
Version 2.0](LICENSE-Apache), or the [Microsoft Public License (Ms‑PL)](LICENSE-Ms-PL). These licenses are essentially identical, but you are
encouraged to evaluate both to determine which best fits your intended use.