ShellDocs.Markdown 0.1.5-alpha

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
This is a prerelease version of ShellDocs.Markdown.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package ShellDocs.Markdown --version 0.1.5-alpha
                    


                    

                
NuGet\Install-Package ShellDocs.Markdown -Version 0.1.5-alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ShellDocs.Markdown" Version="0.1.5-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ShellDocs.Markdown" Version="0.1.5-alpha" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ShellDocs.Markdown" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ShellDocs.Markdown --version 0.1.5-alpha
                    


                    

                
#r "nuget: ShellDocs.Markdown, 0.1.5-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ShellDocs.Markdown@0.1.5-alpha
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ShellDocs.Markdown&version=0.1.5-alpha&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ShellDocs.Markdown&version=0.1.5-alpha&prerelease
                    


                            Install as a Cake Tool

ShellDocs

The docs framework for .NET. Beautiful, animated, Cmd+K-searchable documentation sites. Powered by Blazor, styled with Tailwind-shaped design tokens, composable with any Blazor component library. The fumadocs / shadcn pattern, ported to .NET.

0.1.2-alpha on nuget.org. See CHANGELOG and ROADMAP. Docs at shelldocs.dev.

Quick start

# Install the CLI (once)
dotnet tool install -g ShellDocs.CLI --prerelease

# Scaffold a site (creates docs/MyDocs.Docs/)
shelldocs init MyDocs

# Add pages
shelldocs add component Button
shelldocs add guide getting-started

# Run with hot reload
cd docs/MyDocs.Docs
shelldocs dev

# Ship
shelldocs build --output publish

That's a working docs site. See shelldocs.dev/docs/getting-started/quick-start for the walkthrough.

What you get

  • Markdown-first authoring. YAML frontmatter, fenced code blocks with Shiki, live-rendered razor:preview examples, inline Razor component tags mid-prose.
  • Auto-wired navigation. File-based routing. Drop a .md in content/docs/ and it becomes a page. Sidebar, breadcrumb, prev/next, TOC — all derived from the tree.
  • Cmd+K search. Client-side substring scoring against title, description, section, and body text. Snippet extraction for body-only hits. Zero backend, zero external service.
  • Blazor-native. Components render as real Razor. Full JS interop, hot reload, all the tooling you already have.
  • Composable. Bring your own component library (ShellUI, MudBlazor, Radzen, hand-rolled). One-line assembly-scan registration: 
    o.RegisterComponentsFromAssembly<MyLib.Button>();
  • Static site output. shelldocs build produces static HTML ready for GitHub Pages, Vercel, Netlify, Cloudflare, anywhere. Base-href rewrite + SPA 404 fallback included.

Package family

Package Purpose
ShellDocs.CLI Global tool. shelldocs init, add, dev, build
ShellDocs.Components RCL. Chrome (layout, sidebar, header, search) + content primitives (Callout, Card, Steps, CodeGroup, FileTree, TypeTable, ComponentPreview)
ShellDocs.Markdown Markdig pipeline. Frontmatter parser, razor:preview fence extractor, inline Razor tag extractor, per-property type coercion
ShellDocs.Core Navigation graph, search index, plain-text extraction. No UI
ShellDocs.Tokens Design-system CSS variables. shadcn-compatible names for interop with ShellUI and Tailwind-shaped design systems
ShellDocs.Templates Starter markdown + Program.cs snippets emitted by shelldocs init

Docs

Contributing

The alpha is API-fluid : we're taking freedom to break minor versions until 1.0. Bug reports and dogfood-driven fixes welcome via issues. A proper CONTRIBUTING.md lands with the 0.2.0-alpha cut.

License

MIT. Do whatever you want, no warranty.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ShellDocs.Markdown:

Package Downloads
ShellDocs.Components

Blazor RCL for ShellDocs: DocsLayout, sidebar, header, search, TOC, version and package selectors, plus content primitives (Callout, Card, Steps, Tabs, CodeGroup, FileTree, TypeTable, live component previews).

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.12-alpha 36 10/4/2026
0.1.11-alpha 45 10/3/2026
0.1.10-alpha 46 10/2/2026
0.1.9-alpha 41 10/2/2026
0.1.8-alpha 48 10/2/2026
0.1.7-alpha 79 9/7/2026
0.1.6-alpha 77 8/29/2026
0.1.5-alpha 70 8/29/2026
0.1.3-alpha 92 8/11/2026
0.1.2-alpha 77 7/28/2026
0.1.1-alpha 77 7/25/2026
0.1.0-alpha 105 7/25/2026