OutWit.Web.Generator 1.2.0

OutWit.Web.Generator

A .NET CLI tool for generating static content, OG images, sitemap, search index, and RSS feeds for OutWit.Web sites.

Installation

dotnet tool install -g OutWit.Web.Generator

Usage

Automatic Generation (Recommended)

When using OutWit.Web.Framework, content generation runs automatically on Release builds:

1. Install the Generator tool globally
2. In Visual Studio, switch to Release configuration
3. Build your project (Ctrl+Shift+B)
4. Generation runs automatically after build!

Manual CLI Usage

outwit-generate --content-path ./wwwroot/content --output-path ./wwwroot

CLI Options

MSBuild Properties

When using the Framework, configure generation via MSBuild properties in your .csproj:

<PropertyGroup>
  
  <OutWitSiteUrl>https://example.com</OutWitSiteUrl>
  
  
  <OutWitSiteName>My Site</OutWitSiteName>
  
  
  <OutWitHostingProvider>cloudflare</OutWitHostingProvider>
  
  
  <OutWitGenerateStaticPages>true</OutWitGenerateStaticPages>
  <OutWitGenerateSearchIndex>true</OutWitGenerateSearchIndex>
  <OutWitGenerateRssFeed>true</OutWitGenerateRssFeed>
  <OutWitGenerateOgImages>false</OutWitGenerateOgImages>
  
  
  <OutWitGenerateContent>true</OutWitGenerateContent>
</PropertyGroup>

Features

Content Index

Generates index.json listing all content files by category (blog, projects, docs, articles, features) and dynamic sections.

Sitemap

Creates sitemap.xml and robots.txt with proper lastmod dates.

Search Index

Generates search-index.json for client-side search functionality.

RSS Feed

Creates feed.xml for blog posts with proper formatting.

Static HTML

Pre-renders HTML pages for SEO and faster initial load.

OG Images

Generates Open Graph images for social sharing using Playwright.

# Install Playwright before using OG images
npx playwright install chromium

Dynamic Content Sections

Define custom content sections in site.config.json:

{
  "contentSections": [
    { "folder": "solutions", "route": "solutions", "menuTitle": "Solutions" }
  ]
}

GitHub Actions

Example workflow step:

- name: Build and Run Generator
  run: |
    dotnet build OutWit.Web.Generator -c Release
    dotnet run --project OutWit.Web.Generator -c Release -- \
      --content-path publish/wwwroot/content \
      --output-path publish/wwwroot \
      --site-url https://example.com \
      --site-name "My Site"

License

Licensed under the Apache License, Version 2.0. See LICENSE.

Attribution (optional)

If you use OutWit.Web.Generator in a product, a mention is appreciated (but not required), for example: "Powered by OutWit.Web.Generator (https://ratner.io/)".

Trademark / Project name

"OutWit" and the OutWit logo are used to identify the official project by Dmitry Ratner.

You may:

• refer to the project name in a factual way (e.g., "built with OutWit.Web.Generator");
• use the name to indicate compatibility (e.g., "OutWit.Web.Generator-compatible").

You may not:

• use "OutWit.Web.Generator" as the name of a fork or a derived product in a way that implies it is the official project;
• use the OutWit.Web.Generator logo to promote forks or derived products without permission.