Didot-cli 0.5.0

Didot

Transform your structured YAML data into beautiful, fully-customized HTML pages in seconds with Didot. This command-line tool allows you to seamlessly generate HTML from YAML files using your preferred templates. Whether you're building static sites, documentation, or reporting tools, Didot makes it easy to turn raw data into polished, web-ready content.

About | Installing | Quickstart

About

Social media:

Releases:

Dev. activity:

Continuous integration builds:

Status:

Installing

dotnet tool install -g Didot-cli

QuickStart

Didot is a command-line tool designed for generating files based on templating. It supports both YAML and JSON as source data formats and uses Scriban as its templating engine. With Didot, you can easily automate file generation by combining structured data from YAML or JSON files with customizable templates.

Supported Data Formats:

• YAML: Files with the .yaml or .yml extension are parsed using a YAML source parser.
• JSON: Files with the .json extension are parsed using a JSON source parser.
• XML: Files with the .xml extension are parsed using an XML source parser.

Supported Templating Engines:

Didot utilizes some templating engines, which allow for powerful and flexible templating.

• Scriban: Templates with the .scriban extension are parsed using a Scriban template engine. Scriban is a lightweight and fast template engine with rich support for multiple output formats.
  • Highly performant, designed to handle large-scale template processing.
  • Supports customizable scripting with rich expressions and filters.
  • Can work with JSON and YAML data sources.
• dotLiquid: Templates with the .liquid extension are parsed using a dotLiquid template engine. DotLiquid is a .NET port of the Liquid templating engine used by platforms like Shopify.
  • Secure (no access to system objects), making it ideal for user-generated templates.
  • Allows both dynamic and static templating.
  • Supports filters, tags, and various control flow structures.

Command Usage:

The command to run Didot is simply didot. When executing it, you need to provide three required arguments:

• -t, --Template: Specifies the path to the Scriban template file.
• -s, --Source: Specifies the path to the source data file, which can be in YAML or JSON format.
• -o, --Output: Specifies the path to the output file where the generated content will be saved.

Example:

didot -t template.scriban -s data.yaml -o page.html

In this example:

• template.scriban is the Scriban template file.
• data.yaml is the source file containing the structured data in YAML format.
• result.txt is the output file that will contain the generated content.

Make sure that the template file and source file are correctly formatted and aligned with your data model to produce the desired result.