Skip to content

Commit 60bc974

Browse files
committed
docs: centred README header with badges, matching ShellUI
1 parent af7ed7e commit 60bc974

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
![ShellDocs](https://raw.githubusercontent.com/shellui-dev/shelldocs/main/assets/readme-logo.svg)
1+
<p align="center">
2+
<img alt="ShellDocs logo" src="https://raw.githubusercontent.com/shellui-dev/shelldocs/main/assets/readme-logo.svg" width="64" height="64">
3+
</p>
24

3-
# ShellDocs
5+
<h1 align="center">ShellDocs</h1>
46

5-
**The docs framework for .NET.** Markdown-driven documentation sites with live Blazor component previews, versioned docs, `Cmd+K` search, and a static export. Styled with shadcn-shaped design tokens and composable with any Blazor component library. The fumadocs / shadcn pattern, ported to .NET.
7+
<p align="center">
8+
<b>The docs framework for .NET.</b> Markdown-driven documentation sites with live Blazor component previews, versioned docs, <code>Cmd+K</code> search, and a static export.<br/>
9+
Styled with shadcn-shaped design tokens and composable with any Blazor component library. The fumadocs / shadcn pattern, ported to .NET.
10+
</p>
611

7-
[![NuGet](https://img.shields.io/nuget/vpre/ShellDocs.CLI?label=ShellDocs.CLI)](https://www.nuget.org/packages/ShellDocs.CLI) — alpha: APIs may change between minor versions. See the [CHANGELOG](CHANGELOG.md) and [ROADMAP](docs/ROADMAP.md).
12+
<p align="center">
13+
<a href="https://github.com/shellui-dev/shelldocs"><img src="https://img.shields.io/github/stars/shellui-dev/shelldocs?style=flat-square" alt="GitHub stars"></a>
14+
<a href="https://www.nuget.org/packages/ShellDocs.Components"><img src="https://img.shields.io/nuget/vpre/ShellDocs.Components?style=flat-square&logo=nuget&color=004880" alt="ShellDocs.Components on NuGet"></a>
15+
<a href="https://www.nuget.org/packages/ShellDocs.CLI"><img src="https://img.shields.io/nuget/vpre/ShellDocs.CLI?style=flat-square&logo=nuget&label=CLI&color=004880" alt="ShellDocs.CLI on NuGet"></a>
16+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license"></a>
17+
</p>
18+
19+
Alpha: APIs may change between minor versions. See the [CHANGELOG](CHANGELOG.md) and [ROADMAP](docs/ROADMAP.md).
820

921
## Quick start
1022

0 commit comments

Comments
 (0)