pkg

CodingBoson/Boson.WebKitv1.3.0

WebKit is a lightweight and fast .NET tool for building static websites, blogs, and documentation from Markdown. It works as a cross-platform CLI (dotnet tool) designed for developers who want an easy and flexible site generator. With WebKit, you can turn Markdown into HTML, generate static sites, and create modern Jamstack-style projects without complex setups. Perfect for personal blogs, project documentation, and fast content-driven websites. Key features: * Cross-platform .NET CLI tool (`dotnet tool install`) * Markdown to HTML conversion * Static site and blog generator * Lightweight, fast, and developer-friendly * Ideal for Jamstack workflows and documentation sites

github.com ↗

License

View license

Deps

Install Size

—

Vulns

✓ 0

Published

Oct 10, 2025

Get Started

$ dotnet add package Boson.WebKit

Readme

WebKit

WebKit is a hybrid Markdown + HTML site engine written in C#.
It transforms simple .md pages into clean, responsive websites — with built-in layouts, dark/light mode, and expression support.

✨ Features

Responsive layout 📱
Dark 🌙 + Light ☀️ mode
Hybrid Markdown + HTML syntax
Simple expressions with Getters + Setters
Configurable via webkit.json

📦 Installation

Using .NET Tool

dotnet tool install -g Boson.WebKit

⚡ Quick Start

webkit init -n MySite
cd MySite
webkit build
webkit serve

Open http://localhost:3000 🎉

⚙️ Configuration

webkit.json

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Access with expressions:

# Welcome to {{ .Name }} by {{ .Author }}

📂 Project Structure

MySite/
 ├─ build/                 # Generated output
 ├─ Resources/             # All resources live here
 │   ├─ Pages/             # Markdown + hybrid HTML pages
 │   ├─ Shared/            # Reusable components
 │   ├─ Static/            # CSS, JS, images
 │   └─ Layout.html        # Global layout
 ├─ .gitignore
 ├─ README.md
 └─ webkit.json            # Site config

🛠 Commands

webkit init <Name>     # Create new site
webkit build           # Build static site
webkit serve           # Run local dev server
webkit clean           # Clear build output

Layout

The Layout.html in Resources/ defines the global wrapper for your pages.
Every page gets rendered inside this layout.

Example:

<!DOCTYPE html>
<html>
<head>
  <title>{{ .Title }}</title>
  <link rel="stylesheet" href="/webkit.css">
</head>
<body>
  {{ .NavBar }}
  <main>
    {{ .Content }}
  </main>
  <footer>
    <p>© {{ .Name }} by {{ .Author }}</p>
  </footer>
</body>
</html>

Shared Components

In WebKit, shared components are just resources inside Resources/Shared/.

To use them:

Create a file in Resources/Shared/ (e.g. NavBar.html)
Reference it in webkit.json
Use it as a property in any page or layout

Example

Resources/Shared/NavBar.html

<nav>
  <a href="/">Home</a>
  <a href="/About.html">About</a>
</nav>

webkit.json

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson",
    // First, define a property in the `webkit.json` that references the shared HTML/markdown file. "NavBar": "@Shared/NavBar.html"
    "NavBar": "@Shared/NavBar.html"
  }
}

Layout.html

<body>
  {{ .NavBar }}
  <main>{{ .Content }}</main>
</body>

Philosophy

No new syntax → Components are just properties.
No hidden magic → WebKit doesn’t treat Shared/ specially. It’s just a folder convention.
Uniform API → Whether you use .Name, .Author, or .NavBar, it’s the same expression system.

This makes WebKit:

Predictable → All resources behave the same
Simple → No separate “component language”
Composable → You can nest and reuse shared parts freely

📑 Expressions

# Expressions

WebKit supports **expressions** inside Markdown and HTML.  
They are written with double curly braces:

```markdown
{{ .Property }}

1. Getters

A Getter inserts the value of a property.

Example:

Welcome to {{ .Name }} by {{ .Author }}

With this config:

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Result:

Welcome to MySite by CodingBoson

2. Shared Resource References

Properties in webkit.json can point to other resources, like files in Resources/Shared/.

{
  "Properties": {
    "NavBar": "@Shared/NavBar.html"
  }
}

Now you can use:

{{ .NavBar }}

WebKit will inline the content of Resources/Shared/NavBar.html.

3. SetterExpressions

A SetterExpression allows you to define or override a property inside a page.

Syntax:

{{ .Property = value }}

Example:

{{ .Title = .Name Home }}

# Welcome to {{ .Name }}

Here:

.Title is set to "MySite Home"
It can be used later in Layout.html (e.g., inside <title>)

4. Concatenation in Setters

Setters can concatenate multiple values:

{{ .Title = .Name " - " .Author }}

With:

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Result:

<title>MySite - CodingBoson</title>

5. Resolution Order

When WebKit resolves an expression:

Check runtime Setters (defined in the current page)
Check webkit.json Properties
If value is a resource reference (e.g., @Shared/...), load its content
Fallback → leave the expression untouched

This makes expressions predictable:

Pages can override defaults (via Setters)
Layouts and Shared resources stay flexible

6. Escaping Expressions

To write an expression literally (without evaluating it), escape with \\:

\\{{ .Author }}

Result:

{{ .Author }}

Philosophy

Expressions are the glue of WebKit:

Getters → read values
Setters → define or override values
References → pull in resources
All unified under one minimal syntax

👉 No custom DSL. 👉 No templates-within-templates. 👉 Just properties + resources, flowing through the build pipeline.

📜 License

GPL-3.0 © BosonWare Technologies

Release Notes:

Check the Changelog for more details.

WebKit

WebKit is a hybrid Markdown + HTML site engine written in C#.
It transforms simple .md pages into clean, responsive websites — with built-in layouts, dark/light mode, and expression support.

✨ Features

Responsive layout 📱
Dark 🌙 + Light ☀️ mode
Hybrid Markdown + HTML syntax
Simple expressions with Getters + Setters
Configurable via webkit.json

📦 Installation

Using .NET Tool

dotnet tool install -g Boson.WebKit

⚡ Quick Start

webkit init -n MySite
cd MySite
webkit build
webkit serve

Open http://localhost:3000 🎉

⚙️ Configuration

webkit.json

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Access with expressions:

# Welcome to {{ .Name }} by {{ .Author }}

📂 Project Structure

MySite/
 ├─ build/                 # Generated output
 ├─ Resources/             # All resources live here
 │   ├─ Pages/             # Markdown + hybrid HTML pages
 │   ├─ Shared/            # Reusable components
 │   ├─ Static/            # CSS, JS, images
 │   └─ Layout.html        # Global layout
 ├─ .gitignore
 ├─ README.md
 └─ webkit.json            # Site config

🛠 Commands

webkit init <Name>     # Create new site
webkit build           # Build static site
webkit serve           # Run local dev server
webkit clean           # Clear build output

Layout

The Layout.html in Resources/ defines the global wrapper for your pages.
Every page gets rendered inside this layout.

Example:

<!DOCTYPE html>
<html>
<head>
  <title>{{ .Title }}</title>
  <link rel="stylesheet" href="/webkit.css">
</head>
<body>
  {{ .NavBar }}
  <main>
    {{ .Content }}
  </main>
  <footer>
    <p>© {{ .Name }} by {{ .Author }}</p>
  </footer>
</body>
</html>

Shared Components

In WebKit, shared components are just resources inside Resources/Shared/.

To use them:

Create a file in Resources/Shared/ (e.g. NavBar.html)
Reference it in webkit.json
Use it as a property in any page or layout

Example

Resources/Shared/NavBar.html

<nav>
  <a href="/">Home</a>
  <a href="/About.html">About</a>
</nav>

webkit.json

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson",
    // First, define a property in the `webkit.json` that references the shared HTML/markdown file. "NavBar": "@Shared/NavBar.html"
    "NavBar": "@Shared/NavBar.html"
  }
}

Layout.html

<body>
  {{ .NavBar }}
  <main>{{ .Content }}</main>
</body>

Philosophy

No new syntax → Components are just properties.
No hidden magic → WebKit doesn’t treat Shared/ specially. It’s just a folder convention.
Uniform API → Whether you use .Name, .Author, or .NavBar, it’s the same expression system.

This makes WebKit:

Predictable → All resources behave the same
Simple → No separate “component language”
Composable → You can nest and reuse shared parts freely

📑 Expressions

# Expressions

WebKit supports **expressions** inside Markdown and HTML.  
They are written with double curly braces:

```markdown
{{ .Property }}

1. Getters

A Getter inserts the value of a property.

Example:

Welcome to {{ .Name }} by {{ .Author }}

With this config:

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Result:

Welcome to MySite by CodingBoson

2. Shared Resource References

Properties in webkit.json can point to other resources, like files in Resources/Shared/.

{
  "Properties": {
    "NavBar": "@Shared/NavBar.html"
  }
}

Now you can use:

{{ .NavBar }}

WebKit will inline the content of Resources/Shared/NavBar.html.

3. SetterExpressions

A SetterExpression allows you to define or override a property inside a page.

Syntax:

{{ .Property = value }}

Example:

{{ .Title = .Name Home }}

# Welcome to {{ .Name }}

Here:

.Title is set to "MySite Home"
It can be used later in Layout.html (e.g., inside <title>)

4. Concatenation in Setters

Setters can concatenate multiple values:

{{ .Title = .Name " - " .Author }}

With:

{
  "Properties": {
    "Name": "MySite",
    "Author": "CodingBoson"
  }
}

Result:

<title>MySite - CodingBoson</title>

5. Resolution Order

When WebKit resolves an expression:

Check runtime Setters (defined in the current page)
Check webkit.json Properties
If value is a resource reference (e.g., @Shared/...), load its content
Fallback → leave the expression untouched

This makes expressions predictable:

Pages can override defaults (via Setters)
Layouts and Shared resources stay flexible

6. Escaping Expressions

To write an expression literally (without evaluating it), escape with \\:

\\{{ .Author }}

Result:

{{ .Author }}

Philosophy

Expressions are the glue of WebKit:

Getters → read values
Setters → define or override values
References → pull in resources
All unified under one minimal syntax

👉 No custom DSL. 👉 No templates-within-templates. 👉 Just properties + resources, flowing through the build pipeline.

📜 License

Release Notes:

Check the Changelog for more details.