Small .NET console app to render Scriban templates. Makes developing Scriban templates much easier and faster.
git clone- Run the app using
dotnet run - Open the generated HTML page in the
outputdirectory
Follow the steps below to create a new .NET Console App and add the Scriban NuGet package to it.
templatesdirectory: Contains all the Scriban templatesoutputdirectory: Contains the generated HTML pagesProgram.cs: The main file that contains the code to render the templatesindex.sb: A sample Scriban templatesample.sb: A more complex sample Scriban template with loops, conditionals and data.
.
├── Program.cs
├── README.md
├── bin
│ └── Debug
├── obj
├── output
│ ├── index.html
│ └── sample.html
├── scriban-dev.csproj
└── templates
├── index.sb
└── sample.sb
- Ensure you can run dotnet commands in your terminal
- test by running
dotnet --versionin your terminal. If you get a version number, you are good to go. If not, you can install the .NET SDK from here
- create a new .NET Console App
dotnet new console -n ScribanTemplate
cd ScribanTemplate
- Add the Scriban NuGet package
dotnet add package Scriban
- Replace the content of Program.cs with the following code:
using System;
using System.IO;
using Scriban;
class Program
{
static void Main()
{
string templateDirectory = "./templates"; // Directory containing Scriban templates
string outputDirectory = "output"; // Directory where the generated HTML pages will be saved
// Get all Scriban template files in the template directory
string[] templatePaths = Directory.GetFiles(templateDirectory, "*.sb");
foreach (string templatePath in templatePaths)
{
// Read Scriban template from file
string templateContent = File.ReadAllText(templatePath);
// Process the template
var template = Template.Parse(templateContent);
var result = template.Render();
// Create the output directory if it doesn't exist
if (!Directory.Exists(outputDirectory))
{
Directory.CreateDirectory(outputDirectory);
}
// Write the result to an HTML file
string outputFileName = Path.GetFileNameWithoutExtension(templatePath) + ".html";
string outputPath = Path.Combine(outputDirectory, outputFileName);
File.WriteAllText(outputPath, result);
Console.WriteLine($"Static page generated at: {outputPath}");
}
}
}- Create a new file
index.sbin thetemplates folderof your project and add the following markup:
- Run the app using the following command:
dotnet run
You should see the following output:
Static page generated at: output/index.html-
Open
output/index.htmlfile to see the generated HTML page. -
To avoid having to run
dotnet runevery time you make a change to the template, you can use thedotnet watchcommand:
dotnet watch run
- Learn more about dotnet watch here
- So that dotnet watch can detect changes to any template file, you need to add the following to your .csproj file:
<ItemGroup>
<Watch Include="**/*.sb" Exclude="bin\**;obj\**;**\*.xlf;packages\**" />
</ItemGroup>
- Optional: To be able to also reload the generated HTML page in the browser, you can use the
live-serverpackage or if you want to use IIS you just need to create a site pointing to the output folder (I find live-server easier :) ).
- Install
live-serverusing the following command: - Make sure you have Node.js installed.
npm install -g live-server
- Run the following command to start the live server:
live-server output --port=8080 --watch
outputis the directory where the generated HTML page is saved--port=8080is the port number that the server will listen on. You can change this to any port number you want.--watchtells the server to watch for changes in theoutputdirectory
Now, every time you make a change to any of the scriban templates, the HTML page will be automatically reloaded in the browser.
live-server documentation can be found here
For more information about Scriban, check the official documentation.