https://github.com/csainty/veil

A template renderer / view engine for .NET
https://github.com/csainty/veil

aspnetcore dotnet-standard dotnetcore nancyfx veil

Last synced: about 2 months ago
JSON representation

A template renderer / view engine for .NET

• Host: GitHub
• URL: https://github.com/csainty/veil
• Owner: csainty
• License: mit
• Created: 2014-03-22T21:38:09.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-16T12:17:23.000Z (over 7 years ago)
• Last Synced: 2024-11-09T15:19:53.775Z (about 2 months ago)
• Topics: aspnetcore, dotnet-standard, dotnetcore, nancyfx, veil
• Language: C#
• Homepage:
• Size: 553 KB
• Stars: 24
• Watchers: 5
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Veil

Veil is a .NET template renderer / view engine. It is designed to support many syntax parsers which sit on top of a single optimized compiler.

See [Veil.SuperSimple](https://github.com/csainty/Veil/tree/master/Src/Veil.SuperSimple) and [Veil.Handlebars](https://github.com/csainty/Veil/tree/master/Src/Veil.Handlebars) for examples of supported syntax.

### Design Goals

* Easy to install, configure and use in any project

* Fastest view engine available

* Support for explicit flush to aid in browser performance

* Cross-platform support

### Not supported

Unlike Razor, Veil templates are not compiled with the full .NET compilers. This is part of what makes Veil so much easier to integrate and work with. The cost of this approach is that arbitrary code blocks are not supported.

A purist may argue this is actually a good thing :)

### Getting Started

You have a few options for using Veil :-

1. If you are using [Nancy](https://github.com/NancyFx/Nancy) then install the [Nancy.ViewEngines.Veil](http://www.nuget.org/packages/Nancy.ViewEngines.Veil) package and your preferred syntax parsers e.g. [Veil.Handlebars](http://www.nuget.org/packages/Veil.Handlebars) or [Veil.SuperSimple](http://www.nuget.org/packages/Veil.SuperSimple)

2. Alternatively you can install and use any Veil syntax parser directly in any application. E.g.

````

Install-Package Veil.Handlebars

// Compile your template once with the chosen parser

var template = "Hello {{ Name }}";

var compiledTemplate = new VeilEngine().Compile("handlebars", new StringReader(template));

--

// Execute your template as needed

using (var writer = new StringWriter()) {

    compiledTemplate(writer, new ViewModel { Name = "Bob" });

}

````

### Further Information

* [Try the Veil parsers in your browser](http://tryveil.com)

* [Getting Started with Nancy](http://blog.csainty.com/2014/06/veil-getting-started-nancy.html)

* [Getting Started Standalone](http://blog.csainty.com/2014/07/veil-getting-started-standalone.html)

### Builds

[![Build status](https://ci.appveyor.com/api/projects/status/cad383bewb58svi1/branch/master?svg=true)](https://ci.appveyor.com/project/csainty/veil/branch/master)

Pre-built binaries of the latest commit are always available at [https://ci.appveyor.com/project/csainty/veil/build/artifacts](https://ci.appveyor.com/project/csainty/veil/build/artifacts)

Alternatively you can grab them from the AppVeyor nuget feed -

```

    

```