Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 0 additions & 61 deletions .github/workflows/docs.yml

This file was deleted.

27 changes: 3 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ shell-icons/
├── RELEASING.md how to cut a release
├── LUCIDE_VERSION.txt pinned upstream tag
├── NOTICE.md Lucide ISC attribution
├── ShellIcons.slnx Blazor, Avalonia, generators, tests, docs — no MAUI workload needed
├── ShellIcons.slnx Blazor, Avalonia, generators, tests — no MAUI workload needed
├── ShellIcons.Maui.slnx MAUI projects — needs `dotnet workload install maui`
├── Directory.Build.props
├── catalog/
Expand All @@ -101,35 +101,14 @@ shell-icons/
│ ├── ShellIcons.Blazor.Tests/ xUnit + bUnit: components, factory, dispatcher, collisions
│ ├── ShellIcons.Maui.Tests/ headless MAUI: controls, XAML, whole-catalog geometry
│ └── ShellIcons.Avalonia.Tests/ headless Avalonia with Skia: controls, XAML, renders of every icon
├── docs/
│ └── ShellIcons.Docs/ ShellDocs site — dev at http://localhost:5145
└── .github/workflows/
├── ci.yml ubuntu: ShellIcons.slnx · windows: ShellIcons.Maui.slnx
├── release.yml tag → all three packages on NuGet (Trusted Publishing) + GitHub Release
└── docs.yml static build → GitHub Pages
└── release.yml tag → all three packages on NuGet (Trusted Publishing) + GitHub Release
```

## Docs

Run the docs locally:

```bash
cd docs/ShellIcons.Docs
dotnet run
```

Serves at http://localhost:5145. Pages live in `docs/ShellIcons.Docs/content/docs/*.md`. Live component previews via `razor:preview` code fences work out of the box.

`/docs/icons` is a searchable browser of the entire catalog with click-to-copy component names.

Build the static site the way the deploy workflow does (needs `dotnet tool install -g ShellDocs.CLI --version 0.1.19-alpha`):

```bash
cd docs/ShellIcons.Docs
shelldocs build --output ../../publish --spa-fallback --site-url https://shellicons.shellui.dev
```

Every page under `content/` is prerendered to plain HTML, so any static host can serve `publish/`. Pages added as Razor `@page` routes outside `content/` are not prerendered — put new pages in `content/` (a component can be used from markdown, as `content/docs/icons.md` does).
The docs site, [shellicons.shellui.dev](https://shellicons.shellui.dev), lives in its own repo: [shellui-dev/shell-icons-docs](https://github.com/shellui-dev/shell-icons-docs). It uses the published packages, so update it after a release.

## Refreshing the Lucide catalog

Expand Down
2 changes: 1 addition & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ How to ship a new version of `ShellIcons.Blazor`, `ShellIcons.Maui` and `ShellIc

**Who can release:** anyone who can approve the `release` environment on GitHub. Contributors without that access open a PR; a maintainer does the release.

**What's released:** all three packages, at the one version in `Directory.Build.props`. `release.yml` runs on `windows-latest` and installs the MAUI workload, because `ShellIcons.Maui` builds for Android, iOS, Mac Catalyst and Windows. The docs site isn't part of a release either: it deploys to [shellicons.shellui.dev](https://shellicons.shellui.dev) on every push to `main` (`docs.yml`).
**What's released:** all three packages, at the one version in `Directory.Build.props`. `release.yml` runs on `windows-latest` and installs the MAUI workload, because `ShellIcons.Maui` builds for Android, iOS, Mac Catalyst and Windows. The docs site isn't part of a release: it lives in [shellui-dev/shell-icons-docs](https://github.com/shellui-dev/shell-icons-docs) and uses the published packages, so bump `ShellIcons.Blazor` there after a release.

Publishing uses **NuGet Trusted Publishing** — GitHub Actions authenticates via OIDC and gets a short-lived (~1 hour) API key per run. No long-lived key lives in the repo.

Expand Down
3 changes: 0 additions & 3 deletions ShellIcons.slnx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
<Platform Name="x64" />
<Platform Name="x86" />
</Configurations>
<Folder Name="/docs/">
<Project Path="docs/ShellIcons.Docs/ShellIcons.Docs.csproj" />
</Folder>
<Folder Name="/src/">
<Project Path="src/ShellIcons.Avalonia/ShellIcons.Avalonia.csproj" />
<Project Path="src/ShellIcons.Blazor/ShellIcons.Blazor.csproj" />
Expand Down
45 changes: 0 additions & 45 deletions docs/ShellIcons.Docs/Components/App.razor

This file was deleted.

137 changes: 0 additions & 137 deletions docs/ShellIcons.Docs/Components/IconBrowser.razor

This file was deleted.

2 changes: 0 additions & 2 deletions docs/ShellIcons.Docs/Components/Layout/MainLayout.razor

This file was deleted.

43 changes: 0 additions & 43 deletions docs/ShellIcons.Docs/Components/Pages/DocsPage.razor

This file was deleted.

36 changes: 0 additions & 36 deletions docs/ShellIcons.Docs/Components/Pages/Error.razor

This file was deleted.

Loading
Loading