Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
ca95e1f
feat(llmstxt): code init
ice6 Jan 1, 2026
7f46647
feat(ComponentAnalyzer): simplify type name handling and add regex fo…
ice6 Jan 2, 2026
1c289ee
fix: sync the llmstxt outputs
ice6 Jan 2, 2026
22d5c39
feat(DocsGenerator): add check for index file freshness against compo…
ice6 Jan 2, 2026
ca50a4b
fix(typo): multiple typos fixed
ice6 Jan 2, 2026
d270498
refactor(ComponentAnalyzer): simplify GetClassName method by removing…
ice6 Jan 2, 2026
d80739b
feat: 添加 LlmsDocsGenerator 的中文文档
ice6 Jan 2, 2026
e1ae93a
refactor: 更改文件夹名称为 llms
ArgoZhang Jan 2, 2026
4cce1c4
chore: 更新忽略文件
ArgoZhang Jan 2, 2026
c44e11f
chore: 增加 llms 工具项目
ArgoZhang Jan 2, 2026
d05e49f
chore: 移除 llms 静态文件
ArgoZhang Jan 2, 2026
2c2a21b
revert: 撤销 build action 更改
ArgoZhang Jan 2, 2026
b44f47e
revert: 撤销 docker action 更改
ArgoZhang Jan 2, 2026
df7707f
revert: 撤销 dockerfile 更新
ArgoZhang Jan 2, 2026
ebe23bb
Merge remote-tracking branch 'origin/main'
ArgoZhang Jan 2, 2026
99741e8
fix(DocsGenerator): 修复获取最新组件源文件时间戳的逻辑
ice6 Jan 2, 2026
9558688
fix(DocsGenerator): 使用组件的最后修改时间替代源文件时间戳计算最新组件时间
ice6 Jan 2, 2026
073d26e
feat(DocsGenerator): 确保输出目录存在以避免文件写入错误
ice6 Jan 2, 2026
6cf4a8e
feat(DocsGenerator): 添加 CLI 工具配置和使用说明
ice6 Jan 2, 2026
2d9cf90
chore: 更新字典增加 llms 单词
ArgoZhang Jan 2, 2026
5713f1c
doc: 更新 readme 文档
ArgoZhang Jan 2, 2026
113f1e2
chore: 增加 llms-docs 自动化脚本
ArgoZhang Jan 2, 2026
7ec4e74
typo
ice6 Jan 2, 2026
27a106a
fix: 修正 llmsdocsgenerator 的包名和命令行工具名称
ice6 Jan 2, 2026
44509c5
chore: 更新依赖到最新
ArgoZhang Jan 2, 2026
b6c9dd3
refactor: 重构代码防止参数为空
ArgoZhang Jan 2, 2026
b2d0ee2
refactor: 修正生成文件目标位置逻辑
ArgoZhang Jan 2, 2026
4a80d40
refactor: 代码格式化
ArgoZhang Jan 2, 2026
1ee4a4c
chore: 更新 dotnet tool cli
ArgoZhang Jan 2, 2026
7d040c0
feat: 增加 --root 参数适配 cli
ArgoZhang Jan 2, 2026
17bc3bf
feat: 增加调试信息输出配置
ArgoZhang Jan 2, 2026
d2da910
feat: 重构文档生成逻辑,支持每个组件单独生成文档文件
ice6 Jan 2, 2026
ee0c216
chore: remove project into extensions lib
ArgoZhang Jan 3, 2026
260b7fc
revert: 撤销更改
ArgoZhang Jan 3, 2026
89f0100
revert: 撤销更改
ArgoZhang Jan 3, 2026
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
4 changes: 4 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,7 @@ jobs:
- name: Check Localizer
run: |
dotnet test test/UnitTest.Localization

- name: Check LLM Documentation
run: |
dotnet run --project tools/LlmsDocsGenerator -- --check
10 changes: 10 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ jobs:

steps:
- uses: actions/checkout@v4

- name: Setup .NET Core SDK
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x

- name: Generate LLM Documentation
run: |
dotnet run --project tools/LlmsDocsGenerator

- name: Login to Docker Hub
uses: docker/login-action@v3
with:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -379,3 +379,6 @@ src/**/wwwroot/**/uploader

# css
**/BootstrapBlazor/wwwroot/css/bootstrap.blazor.bundle.*.css

# Code Agents
.claude
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,64 @@ dotnet new install Bootstrap.Blazor.Templates::*
dotnet new bbapp
```

## For AI Code Agents

This project includes LLM-friendly documentation to help AI coding assistants (Claude Code, Cursor, GitHub Copilot, etc.) generate correct component usage.

### Online Access

Documentation files are available at: `https://www.blazor.zone/llmstxt/`

| File | URL |
|------|-----|
| Index | https://www.blazor.zone/llmstxt/llms.txt |
| Table | https://www.blazor.zone/llmstxt/llms-table.txt |
| Input | https://www.blazor.zone/llmstxt/llms-input.txt |
| Select | https://www.blazor.zone/llmstxt/llms-select.txt |
| Button | https://www.blazor.zone/llmstxt/llms-button.txt |
| Dialog | https://www.blazor.zone/llmstxt/llms-dialog.txt |
| Nav | https://www.blazor.zone/llmstxt/llms-nav.txt |
| Card | https://www.blazor.zone/llmstxt/llms-card.txt |
| TreeView | https://www.blazor.zone/llmstxt/llms-treeview.txt |
| Form | https://www.blazor.zone/llmstxt/llms-form.txt |
| Other | https://www.blazor.zone/llmstxt/llms-other.txt |

### Using in Your Project

Create a `llms.txt` in your project root to reference BootstrapBlazor documentation.

See the full example template: https://www.blazor.zone/llmstxt/llms-example-project.txt

Quick example:

```markdown
# My Project

## Dependencies

### BootstrapBlazor
- NuGet: BootstrapBlazor
- Documentation: https://www.blazor.zone/llmstxt/llms.txt
- Source Code: https://github.com/dotnetcore/BootstrapBlazor

For component parameters and usage:
- Table: https://www.blazor.zone/llmstxt/llms-table.txt
- Dialog: https://www.blazor.zone/llmstxt/llms-dialog.txt
- ... (add others as needed)
```

### Regenerate Documentation

```bash
dotnet run --project tools/LlmsDocsGenerator
```

### Check Documentation Freshness

```bash
dotnet run --project tools/LlmsDocsGenerator -- --check
```

## Contribution
1. Fork
2. Create Feat_xxx branch
Expand Down
6 changes: 5 additions & 1 deletion src/BootstrapBlazor.Server/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
WORKDIR /
COPY . .

WORKDIR "src/BootstrapBlazor.Server"
# Generate LLM documentation
WORKDIR /tools/LlmsDocsGenerator
RUN dotnet run
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Outdated
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Outdated

WORKDIR "/src/BootstrapBlazor.Server"
FROM build AS publish
RUN dotnet build
RUN dotnet publish -c Release -o /app
Expand Down
Loading