Skip to content

Commit e9bca15

Browse files
ShewartShewart
committed
chore: add initial project configuration files including .gitignore, Directory.Build.props, and Directory.Packages.props. Introduce LICENSE file and solution structure for ShellDocs with project references for CLI, components, core, markdown, templates, and tests.
1 parent 82bbe7a commit e9bca15

5 files changed

Lines changed: 172 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# .NET build output
2+
[Bb]in/
3+
[Oo]bj/
4+
[Rr]elease/
5+
[Dd]ebug/
6+
*.user
7+
*.suo
8+
*.userosscache
9+
*.sln.docstates
10+
*.dll
11+
*.pdb
12+
*.exe
13+
*.cache
14+
15+
# NuGet
16+
*.nupkg
17+
*.snupkg
18+
project.lock.json
19+
project.assets.json
20+
packages/
21+
!.nuget/packages/
22+
.nuget/
23+
24+
# Test results
25+
[Tt]est[Rr]esult*/
26+
[Cc]overage*/
27+
28+
# IDE
29+
.vs/
30+
.vscode/
31+
.idea/
32+
*.swp
33+
*.swo
34+
35+
# JetBrains Rider
36+
_ReSharper*/
37+
*.[Rr]e[Ss]harper
38+
*.DotSettings.user
39+
40+
# OS
41+
.DS_Store
42+
Thumbs.db
43+
44+
# Node (for Tailwind CLI + Shiki)
45+
node_modules/
46+
package-lock.json
47+
yarn.lock
48+
pnpm-lock.yaml
49+
50+
# ShellDocs — local build artifacts
51+
publish/
52+
dist/
53+
.shelldocs/
54+
*.shellui-classes-generated
55+
56+
# Environment
57+
.env
58+
.env.*
59+
!.env.example
60+
61+
# Logs
62+
*.log
63+
logs/

‎Directory.Build.props‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<Project>
2+
3+
<PropertyGroup>
4+
<TargetFramework>net10.0</TargetFramework>
5+
<LangVersion>latest</LangVersion>
6+
<Nullable>enable</Nullable>
7+
<ImplicitUsings>enable</ImplicitUsings>
8+
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
9+
<WarningsAsErrors>Nullable</WarningsAsErrors>
10+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
11+
<NoWarn>$(NoWarn);CS1591</NoWarn> <!-- suppress "missing XML comment" until we backfill -->
12+
</PropertyGroup>
13+
14+
<!-- Central package version pinning via Directory.Packages.props -->
15+
<PropertyGroup>
16+
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
17+
</PropertyGroup>
18+
19+
<!-- Package metadata (applies to any project with IsPackable=true) -->
20+
<PropertyGroup>
21+
<Authors>ShellUI</Authors>
22+
<Company>ShellUI</Company>
23+
<Copyright>Copyright © 2026 ShellUI</Copyright>
24+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
25+
<PackageProjectUrl>https://github.com/shellui-dev/shelldocs</PackageProjectUrl>
26+
<RepositoryUrl>https://github.com/shellui-dev/shelldocs</RepositoryUrl>
27+
<RepositoryType>git</RepositoryType>
28+
<PackageTags>blazor;docs;documentation;framework;shellui;shadcn;fumadocs;tailwind</PackageTags>
29+
<PackageReadmeFile>README.md</PackageReadmeFile>
30+
<IncludeSymbols>true</IncludeSymbols>
31+
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
32+
<PublishRepositoryUrl>true</PublishRepositoryUrl>
33+
<EmbedUntrackedSources>true</EmbedUntrackedSources>
34+
</PropertyGroup>
35+
36+
<!-- Default: nothing is packable unless the project opts in -->
37+
<PropertyGroup>
38+
<IsPackable>false</IsPackable>
39+
</PropertyGroup>
40+
41+
<!-- Include README in packages that opt in -->
42+
<ItemGroup Condition="'$(IsPackable)' == 'true'">
43+
<None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="\" />
44+
</ItemGroup>
45+
46+
</Project>

‎Directory.Packages.props‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<Project>
2+
3+
<ItemGroup>
4+
<!-- Framework -->
5+
<PackageVersion Include="Microsoft.AspNetCore.Components.Web" Version="10.0.0" />
6+
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="10.0.0" />
7+
<PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.0" />
8+
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.0" />
9+
<PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0" />
10+
11+
<!-- Markdown pipeline -->
12+
<PackageVersion Include="Markdig" Version="0.38.0" />
13+
<PackageVersion Include="YamlDotNet" Version="16.2.1" />
14+
15+
<!-- CLI -->
16+
<PackageVersion Include="System.CommandLine" Version="2.0.0-beta5.25306.1" />
17+
<PackageVersion Include="Spectre.Console" Version="0.49.1" />
18+
19+
<!-- ShellUI (base primitives — added in feat/components-shell once ShellUI is published to NuGet)
20+
<PackageVersion Include="ShellUI.Components" Version="0.4.0" />
21+
-->
22+
23+
<!-- Test stack -->
24+
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
25+
<PackageVersion Include="xunit" Version="2.9.2" />
26+
<PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
27+
<PackageVersion Include="coverlet.collector" Version="6.0.2" />
28+
</ItemGroup>
29+
30+
</Project>

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 ShellUI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎shelldocs.slnx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<Solution>
2+
<Folder Name="/src/">
3+
<Project Path="src/ShellDocs.CLI/ShellDocs.CLI.csproj" />
4+
<Project Path="src/ShellDocs.Components/ShellDocs.Components.csproj" />
5+
<Project Path="src/ShellDocs.Core/ShellDocs.Core.csproj" />
6+
<Project Path="src/ShellDocs.Markdown/ShellDocs.Markdown.csproj" />
7+
<Project Path="src/ShellDocs.Templates/ShellDocs.Templates.csproj" />
8+
</Folder>
9+
<Folder Name="/tests/">
10+
<Project Path="tests/ShellDocs.Tests/ShellDocs.Tests.csproj" />
11+
</Folder>
12+
</Solution>

0 commit comments

Comments
 (0)