Blazorade Scraibe

Blazorade Scraibe is a content publishing framework for static Blazor WebAssembly sites. You author content in Markdown, publish it into static HTML files, and let the Blazor runtime enhance pages with live components where needed.

This section is the canonical documentation set for understanding Scraibe's model, writing content, and operating the publish workflow.

Removing these docs from your site

This documentation is published on your site by default so you have working content to view immediately after setup and a reference for all built-in features. When your own content is ready and you no longer want these docs published, add scraibe-docs to scraibe.publish.excludedContent in the repository-root .config.json file:

{
  "local": {
    "scraibe.publish.excludedContent": [
      "scraibe-docs"
    ]
  }
}

Who this documentation is for

This documentation primarily targets two audience roles:

Content authors: people who write and maintain content pages under /content.
Site builders: people who shape site structure, styling, layouts, hosting, and publish behavior.

If you are a content author, start with:

If you are a site builder, start with:

Start here

If you are new to Scraibe, read these pages first and in order:

The next publish run will skip all pages in this section. The source files remain in /content/scraibe-docs/ and can be re-included at any time by removing the entry.

Core concepts

Architecture positioning - The runtime model and execution contexts in one page.
What Scraibe is and is not - Product boundaries and non-goals.
Constraints and rationale - Plain-language explanation of core architecture constraints.
Runtime glossary - Shared terminology for authoring, publishing, and runtime behavior.

Authoring guides

Content authoring - Frontmatter, structure, routing, assets, and content rules.
Folder configuration - local and scoped configuration inheritance.
Shortcodes - Embed live Blazor components in Markdown.
Mermaid diagrams - Author and render Mermaid diagrams in content.

Site builder guides

Page layouts - Layout slots and content-part composition.
Styling - Bootstrap SCSS pipeline and theme customization.
Hosting - Hosting choices and why routing support matters.
Prerequisites - Tools required for setup and local work.

Operational reference

Publishing - How publish runs, what it generates, and what it does not do.
Runtime glossary - Definitions for core terms used across docs.
Hosting - Routing support implications for SEO and crawler visibility.

How it works

Scraibe pages move through three execution contexts:

Authoring time: write Markdown and frontmatter in /content.
Publish time: convert content to static HTML and supporting artifacts.
Runtime: fetch static HTML and progressively enhance with Blazor components.

Read Architecture positioning for the full model.

todo/home.md - Active tasks, backlog, and completed task flow.
playbooks/home.md - Site-specific repeatable procedures.

Project structure

content/                  Markdown source files
playbooks/                Site-specific procedures
todo/                     Task-tracking documents
templates/                Scaffolding templates
tools/                    Publish script and supporting tools
.github/instructions/     Copilot instruction files
src/                      App and component library projects

Getting started

If you are creating a new site from the template, start from Prerequisites, then ask Copilot to run first-run setup.

Create your new repository here

About the name

Blazorade Scraibe (/skraib/) combines Blazorade and scribe, with the letters AI embedded in the name to reflect the framework's AI-assisted authoring and publishing workflow.