Skip to content

README.md

Latest commit

 

History

History
72 lines (50 loc) · 1.81 KB

README.md

File metadata and controls

72 lines (50 loc) · 1.81 KB
Raw

shelldocs-docs

Source for shelldocs.dev — the official documentation site for ShellDocs, the docs framework for .NET.

This repo IS a ShellDocs site — a Blazor Web App consuming the published ShellDocs.* NuGet packages. It's the primary consumer proof of the framework and the reference for what a well-authored ShellDocs site looks like.

Prerequisites

  • .NET 10 SDK

  • (optional) ShellDocs.CLI global tool for shelldocs add and shelldocs dev:

    dotnet tool install -g ShellDocs.CLI --prerelease

Run locally

dotnet run

Site serves at http://localhost:5200. Or via the CLI:

shelldocs dev --port 5200

Both watch .md, .razor, .cs files and hot-reload.

Add a page

shelldocs add component MyThing         # → content/docs/components/my-thing.md
shelldocs add guide getting-started      # → content/docs/guides/getting-started.md
shelldocs add page faq                   # → content/docs/faq.md

Or hand-drop a .md file into content/docs/**. The nav graph picks it up automatically (meta.json controls ordering only).

Publish

shelldocs build --output publish

Emits a static site into publish/ ready for GitHub Pages / Cloudflare Pages / Netlify / anywhere else.

Content layout

content/
  docs/
    introduction.md
    getting-started/
      installation.md
      quick-start.md
      project-structure.md
      configuration.md
    authoring/          (planned)
    configuration/      (planned)
    components/         (planned)
    cli/                (planned)
    theming.md          (planned)

Framework version

The site currently references ShellDocs.* 0.1.1-alpha. Bump ShellDocs.Site.csproj on new alpha / beta releases.

License

MIT.