Umbraco.Community.Templates.USWDS 1.0.1

USWDS Umbraco Starter Kit

A dotnet new template for creating Umbraco CMS sites built with the U.S. Web Design System (USWDS). Ships with pre-configured document types, 12 USWDS block components, Razor views, a Sass pipeline, and optional demo content modeled after a fictional government agency.

Quick Start

# Install the template
dotnet new install Umbraco.Community.Templates.USWDS

# Create a new site
dotnet new uswds-umbraco -n MyAgency.Web

# Run it
cd MyAgency.Web
dotnet run

On first run, Umbraco installs automatically and uSync imports all document types, data types, and element types. Log into the backoffice at /umbraco with the default dev credentials (admin@admin.local / password123).

Template Parameters

Examples

# Site with demo content to explore
dotnet new uswds-umbraco -n MyAgency.Web --IncludeDemoContent

# Headless-ready site with MCP tooling
dotnet new uswds-umbraco -n MyAgency.Web --IncludeMcp

# Traditional server-rendered site without the Delivery API
dotnet new uswds-umbraco -n MyAgency.Web --DeliveryApi false

Prerequisites

• .NET 10 SDK
• Node.js (for USWDS Sass compilation, if customizing the theme)

Running the Master Project

This repository is both the template source and a runnable Umbraco site. To work on the starter kit itself:

cd USWDS.Site
dotnet run

The site starts with SQLite and unattended install. All schema is managed via uSync in uSync/v17/.

Maintainer Workflow

1. Make changes in the Umbraco backoffice (schema changes auto-export via uSync ExportOnSave)
2. If you updated demo content, click Export All in the uSync dashboard
3. Commit all changes (views, SCSS, uSync files, generated models)
4. Bump the <PackageVersion> in template-pack.csproj
5. Package: dotnet pack template-pack.csproj -o ./nupkg
6. Publish: dotnet nuget push ./nupkg/*.nupkg --source https://api.nuget.org/v3/index.json --api-key YOUR_KEY

Repository Structure

uswds-starter-kit/
├── README.md                  ← You are here (maintainer docs)
├── template-pack.csproj       ← NuGet template packaging project
└── USWDS.Site/                ← The template content (also a runnable Umbraco site)
    ├── README.md              ← Project README (ships with template)
    ├── docs/                  ← Component & page type reference (ships with template)
    ├── Views/                 ← Razor views and partials
    ├── sass/                  ← USWDS Sass source files
    ├── wwwroot/               ← Compiled USWDS assets
    ├── uSync/v17/             ← Exported Umbraco schema and optional content
    ├── umbraco/models/        ← Generated C# models
    └── .template.config/      ← dotnet new template configuration

See USWDS.Site/README.md for project-level documentation.

License

TBD