ShellDocs.Components 0.1.18-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.Components.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package ShellDocs.Components --version 0.1.18-alpha
                    


                    

                
NuGet\Install-Package ShellDocs.Components -Version 0.1.18-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.Components" Version="0.1.18-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ShellDocs.Components" Version="0.1.18-alpha" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ShellDocs.Components" />
                    


                            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.Components --version 0.1.18-alpha
                    


                    

                
#r "nuget: ShellDocs.Components, 0.1.18-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.Components@0.1.18-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.Components&version=0.1.18-alpha&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ShellDocs.Components&version=0.1.18-alpha&prerelease
                    


                            Install as a Cake Tool

ShellDocs

ShellDocs.Components

The Blazor side of ShellDocs, the docs framework for .NET: the docs layout and chrome (sidebar, header, search, table of contents, version and package selectors) and the content components you write in Markdown (Callout, Card, Steps, Tabs, CodeGroup, FileTree, TypeTable, live component previews).

Install

The quickest start is the CLI, which scaffolds a site with everything wired up:

dotnet tool install --global ShellDocs.CLI --prerelease
shelldocs init

To add ShellDocs to an existing Blazor Web App:

dotnet add package ShellDocs.Components --prerelease

builder.Services.AddShellDocs(o =>
{
    o.ContentRoot = Path.Combine(builder.Environment.ContentRootPath, "content");
    o.SiteName = "My Library";
    o.RegisterComponentsFromAssembly<MyLib.Button>();  // your components, usable in Markdown
});

shelldocs init --attach does this for you and writes the App.razor snippets into SHELLDOCS_SETUP.md.

What you get

  • Markdown-first authoring. Frontmatter, highlighted code fences, live razor:preview examples and component tags mid-prose.
  • File-based navigation. Each .md under content/docs/ is a page; meta.json sets order, dividers, subsections and hidden pages.
  • Cmd+K search with body snippets, searched in the browser.
  • Colour presets (o.Theme = ShellDocsTheme.Harbor), light and dark.
  • Versioned docs, redirects and llms.txt for AI agents.
  • Works as a static site. shelldocs build exports every page, and the chrome keeps working there through shelldocs.js.

Alpha: APIs may change between minor versions. MIT licensed.

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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.19-alpha 63 10/21/2026
0.1.18-alpha 52 10/20/2026
0.1.17-alpha 79 10/14/2026
0.1.16-alpha 48 10/14/2026
0.1.15-alpha 66 10/11/2026
0.1.14-alpha 60 10/10/2026
0.1.13-alpha 53 10/10/2026
0.1.12-alpha 67 10/4/2026
0.1.11-alpha 73 10/3/2026
0.1.10-alpha 67 10/2/2026
0.1.9-alpha 62 10/2/2026
0.1.8-alpha 62 10/2/2026
0.1.7-alpha 105 9/7/2026
0.1.6-alpha 85 8/29/2026
0.1.5-alpha 80 8/29/2026
0.1.3-alpha 100 8/11/2026
0.1.2-alpha 97 7/28/2026
0.1.1-alpha 84 7/25/2026
0.1.0-alpha 109 7/25/2026