Inka

Inka is a cross-platform static site generator built with .NET 6, based on rendering Markdown and Razor markups to HTML document.

Status

Pre-Alpha

The software is still under active development and not feature complete or ready for consumption by anyone other than software developers. There may be milestones during the pre-alpha which deliver specific sets of functionality, and nightly builds for other developers or users who are comfortable living on the absolute bleeding edge.

Features

Engine configuration via file
Flexible routing
Markdown and Razor processors
YAML front matter parser
Razor layouting and data context rendering
Less stylesheets preprocessor
Static content copier
HTML document minifier
Rich CLI output
Sitemap generator

Getting Started

Prerequisites

Installation

To install Inka.Engine and its dependencies via .NET Core CLI, execute the following command.

dotnet add package Inka.Engine

To install Inka.Engine and its dependencies via NuGet, execute the following command.

Install-Package Inka.Engine

Basic Usage

The easiest way to get started with Inka is by hosting Inka.Engine inside the .NET Core console application.

To create .NET Core console application, execute the following command.

dotnet new console

To instantiate and run Bootstrapper, use the following code.

using Inka.Engine.Bootstrapping;

await Bootstrapper
    .New()
    .Configure(_ => { })
    .RunAsync()

During the Bootstrapper instantiation, it will create an execution pipeline under the hood. This pipeline could be extended and configured via the preinstalled external modules. To extend and configure the execution pipeline, use the Configure method from the BootstrapperBuilder class.

To run the application, execute the following command.

dotnet run

Modules

Inka provides a set of modules that can be used to extend and customize the static site generation pipeline.

Documents

Markdown

Markdown document module provides Markdown markup to HTML document rendering.

Razor

Razor document module provides Razor markup to HTML document rendering.

Less

Less document module provides .less to .css stylesheets compilation.

Static

Static document module provides copying of static content to the output directory.

MinifyHtml

MinifyHtml document module provides HTML document minification.

Operations

Output

Output operation module provides copying of document content from the pipeline context to the output directory.

Sitemap

Sitemap operation module provides automatic sitemap.xml generation.

Templates

Blog

Blog template provides content structure and pipeline configuration to build a static blog site.

License

This project is licensed under the MIT license.

kokhans/inka