feat(llms.txt): just like https://ant.design/llms.txt

[ice6]

Is there an existing issue for this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

check here(https://llmstxt.org/) and here(https://ant.design/docs/react/llms-cn)

it is very useful for code agents.

Describe the solution you'd like

No response

Additional context

No response

[bb-auto[bot]]

@ice6 Thank you for contacting us. We will give feedback later.

[j4587698]

由于目前blazor是通过ws进行真实渲染内容交互的，所以llms.txt应该毫无作用，它只能提供对应的url链接，但是大模型去读取url的时候只能读到基础内容，无法连接到ws，就没有办法真正的获取到文档正文。
llms-full.txt倒是可以，但是目前由于所有的例子都是实际例子，不是人工维护的，所以目前也没有什么好办法来生成完整的llms-full.txt，这个需求比较难做。

[ice6]

@j4587698 确实，文档网站居然没考虑SEO，可以考虑用blazor ssr生成文档主体部分，或者llms-full.txt也行。有了这个 code agent 就不会胡乱生成标签和属性了，不然现在code agent生成的代码编译都过不了。

[ice6]

如果没有这个东西，目前只能用项目引用的方式，让code agent直接读取 bootstrap blazor 组件源码了。不过这也太hack了。 :)

[j4587698]

blazor本身就没办法seo，内容都是后面自动加载的，所有的code都是从源码里自动读取出来的，如果在预处理里就加载这些源码，那么你有的等了啊

[ice6]

blazor本身就没办法seo，内容都是后面自动加载的，所有的code都是从源码里自动读取出来的，如果在预处理里就加载这些源码，那么你有的等了啊

https://learn.microsoft.com/zh-cn/aspnet/core/blazor/components/class-libraries-and-static-server-side-rendering

我做的项目都是blazor server + ssr 呀，怎么会不能SEO呢 :)

文档网站可能需要从架构层面解决一下，找到方法应该也不是难事儿，体验会好很多。

[ice6]

我特地跑到 https://www.fluentui-blazor.net/ 去看了一下，他们的文档网站居然从ssr切到了wasm...

但网站上还留着这句话：

By default, components use Static Server-side rendering (SSR). 
The component renders to the response stream and there is no interactivity.

......对fluentui-blazor无语了，之前这个站点还是干净的ssr。

这个库的文档倒是code agent友好：

https://antblazor.com/zh-CN/components/overview

[j4587698]

ssr你seo个啥？没意义啊，seo也就是看到loading，有啥意义呢

[ice6]

@j4587698 看下文档很难么，不懂去看看文档再说话呗 :)

https://learn.microsoft.com/zh-cn/aspnet/core/blazor/components/class-libraries-and-static-server-side-rendering

[j4587698]

你开了预渲染然后把你的数据加载都放在init里？然后还要加载两遍？让用户陪着你看白屏吗？

[ice6]

@j4587698 我们现在讨论的是怎么给code agent看到内容。你要讨论用户体验的话，你再去补补知识行不？

[j4587698]

你的官网主要不是给用户看的？你去给code agent看你也不能影响到用户体验。你不要先保证了用户体验再去说怎么给code agent看？

[ice6]

首先这个官网不是我的，是作者 @ArgoZhang 的。

其次，SSR一直把解决白屏、加载慢作为核心卖点，你觉得微软的工程师是白痴，还是你自己在这方面认知太有限了呢？

再者，不用SSR，服务器端完全可以通过user-agent来提供不同内容，不是么？

我提到ssr只是一个解决方案，我自己的问题早就解决了，我在这里给作者提意见，没义务帮你补知识。

[j4587698]

SSR解决白屏的原理是不预渲染，或者预渲染是Loading，哪怕微软，它的例子也是if (xx == null){loading...}else {真正的组件}。到底是谁知识太有限？
从你给一个静态渲染的url我就知道，要不然你根本就没用过静态渲染，要不然你就根本没用过组件库。静态组件不支持js，不支持afterrender，不支持交互，所以这玩意我们组件库至少有一半以上的组件是不能正常用的。
你从开始就自己觉得如何，总以为别人比你知识少，你考虑过没有别人已经知道这些问题呢？

[ice6]

你这方面知识确实少呀。

我问你ssr是不是可以把部分代码输出到html source中去。

你考虑了性能问题，那就加载一部分进去是不是就可以了，剩下的需要交互的部分用blazor server或者wasm或js增强交互是否可行？先静态的这部分是不是可以给code agent看了，剩下需要互动的部分用blazor的机制完成就行了。

其次这个问题fluent-ui的维护者给了更好的方案，见这里：
microsoft/fluentui-blazor#4427

他提出了用MCP Server解决我提出的问题，那是正确的回应方式。而你直接说ssr不行，不是你知识有限而是啥？因为ssr确实可以提供给code agent够用的养料。

blazor本身就没办法seo，内容都是后面自动加载的，这可能是.net 8之前的事情，作者的库都支持到.net 10了。

[ice6]

code agent要看的是html吗?

当然是拉，llms.txt不就是让code agent到对的位置自己去看文档的么？弱一点儿的llm工作起来像爬虫，需要获得html。强一点儿的自己渲染完整页面后直接dom里取数据，一般的code agent都是前者。

[j4587698]

code agent要看的是html吗?

当然是拉，llms.txt不就是让code agent到对的位置自己去看文档的么？弱一点儿的llm工作起来像爬虫，需要获得html。强一点儿的自己渲染完整页面后直接dom里取数据，一般的code agent都是前者。

他看html干啥？他要知道怎么写<Table TItem="Entity">这个组件，不是需要看到这个Table最后渲染成<table><tr><td>你给他看<table><tr><td>没有任何用处

[ice6]

code agent看html，跟人看组件的说明文档是一个道理呀，它看code sample当然帮助更大，所以我本地直接用项目引用的方式，更利落。

[ice6]

SSR解决白屏的原理是不预渲染，或者预渲染是Loading，哪怕微软，它的例子也是if (xx == null){loading...}else {真正的组件}。到底是谁知识太有限？ 从你给一个静态渲染的url我就知道，要不然你根本就没用过静态渲染，要不然你就根本没用过组件库。静态组件不支持js，不支持afterrender，不支持交互，所以这玩意我们组件库至少有一半以上的组件是不能正常用的。 你从开始就自己觉得如何，总以为别人比你知识少，你考虑过没有别人已经知道这些问题呢？

我们组件库，你是BootstrapBlazor的维护者之一么？是的话，我向你们表达一下感谢，不是的话就把话说清楚一些。

你难道看不到我右上角的Member吗？最起码证明我是库的成员之一吧？这玩意还用问吗？

还真看不到，圣诞快乐，:)

[j4587698]

https://github.com/BootstrapBlazor/BootstrapBlazor.MCPServer 哪怕MCP Server的方式，我们也尝试过，但是现在拿不到合适的代码，需要去分那一块是哪一块。我们试过的方法比你想象的多太多了。就是那个搜索，那都是老张花了5万找人做的，专门花钱买了个爬虫来处理。
BB的东西比你想象中多太多了，要做出一个合适的东西来要难得多。

[j4587698]

我们随时欢迎PR，任何PR都会认真对待

[ice6]

@j4587698 谢谢 https://github.com/BootstrapBlazor/BootstrapBlazor.MCPServer 我回头看看，谢谢耐心回复。:)

[ice6]

https://github.com/BootstrapBlazor/BootstrapBlazor.MCPServer 哪怕MCP Server的方式，我们也尝试过，但是现在拿不到合适的代码，需要去分那一块是哪一块。我们试过的方法比你想象的多太多了。就是那个搜索，那都是老张花了5万找人做的，专门花钱买了个爬虫来处理。 BB的东西比你想象中多太多了，要做出一个合适的东西来要难得多。

对你们有了更多的了解，非常感谢你们的贡献和付出！BIG THANKS to @ArgoZhang ! Merry Christmas.

[ArgoZhang]

@ice6 @j4587698 看到二位激烈的讨论有些感触，鞠佬是组件库项目组老成员了，提供了很多扩展组件，还是微软最有价值专家（MVP），对 Blazor 有很深的功底的，但是文字表达很容易造成说者说的是茶杯的事，听着想到的是茶壶，所以各持己见，但是这也不是坏事，有讨论才有进步嘛。

@ice6 我们为了迎合 AI 确实做了一些尝试，显然目前做的不够，但是真的希望有更好的解决方案，哪怕是思路也可以提供一下，我们可以去尝试一下下。

微软每次更新大版本我们都会尝试一次把官网更改成 Auto 或者 wasm 模式，整体评估下来又都回退到 ssr 模式了，NET10 已经我们还没有精力把网站更改成 auto 或者 wasm 进行测试，这个工作量非常大，目前官网实例都是真的例子、能交互的例子，这个官网文档改版过两次，每次都是 6 个月之久（当时都还不到 100 个组件），太耗时了

@ice6 非常感谢对组件库提出过非常非常多的建议以及 bug 报告，代表开发团队对你表示衷心的感谢

[ArgoZhang]

@ice6 网站根路径下增加如下文件

llms-semantic.md

# BootstrapBlazor 组件语义化描述

本文档包含了 BootstrapBlazor 组件库中所有组件的语义化描述信息。

> 总计 230 个组件包含语义化描述

## 组件列表

### Affix

### Ajax

llms.txt

# BootstrapBlazor - Enterprise-class Blazor UI library

- BootstrapBlazor, developed by BootstrapBlazor Group, is a Blazor UI library that aims to provide a high-quality design language and development framework for enterprise-level full stack management systems. It offers a rich set of components and design guidelines, helping developers build modern, responsive, and high-performance web applications.

## Semantic Descriptions

- [BootstrapBlazor Component Semantic Descriptions](https://www.blazor.zone/llms-semantic.md)

## Docs

- [Install](https://raw.githubusercontent.com/dotnetcore/BootstrapBlazor/refs/heads/main/src/BootstrapBlazor.Server/Components/Pages/Install.razor)
- [Introduction](https://raw.githubusercontent.com/dotnetcore/BootstrapBlazor/refs/heads/main/src/BootstrapBlazor.Server/Components/Pages/Introduction.razor)
- [Affix](https://raw.githubusercontent.com/dotnetcore/BootstrapBlazor/refs/heads/main/src/BootstrapBlazor.Server/Components/Samples/Affixs.razor)
- [Ajax](https://raw.githubusercontent.com/dotnetcore/BootstrapBlazor/refs/heads/main/src/BootstrapBlazor.Server/Components/Samples/Ajaxs.razor)

组件路径直接给 github raw 路径

但是这两个文档需要维护，网站内的很多东西其实都是自成一体的，比如例子写好，代码片段等等都是自动维护的（尤其是涉及多语言）。但是这里目前工作量与维护量都不小，如果时间充裕欢迎帮忙维护这两个文件

相关分支：feat-llms

[ice6]

@ArgoZhang fixed.

[ice6]

@ArgoZhang dotnet cli tools done.

[ArgoZhang]

dotnet tool command 更改为 llms-docs

[ice6]

@ArgoZhang 谢谢，代码更新了。这次被你“坑”了，llmsdocsgenerator NOT limsdocsgenerator，查了老半天，哈哈。

[ArgoZhang]

@ice6 sorry 先实现功能，最后再更新文档

[ArgoZhang]

@ice6 大流程基本调通了，编译项目自动通过 cli tool 生成 llms-{component}.txt

我个人感觉一个组件生成一个 llms.txt 都可以，不需要写那个分类的逻辑，不知道合适不合适，通过这个工具，我突然意识到，我们文档每个组件的文档尾部那个参数组件可以使用 cli tool 或者 sg 自动生成，避免人工维护

Rebuild started at 21:18...
Restored C:\Users\Argo\src\BootstrapBlazor\tools\Benchmarks\UnitTest.Benchmarks.csproj (in 29 ms).
Restored C:\Users\Argo\src\BootstrapBlazor\tools\LLMsDocsGenerator\LLMsDocsGenerator.csproj (in 24 ms).
Restored C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\BootstrapBlazor.Server.csproj (in 65 ms).
Restored C:\Users\Argo\src\BootstrapBlazor\test\UniTest.Sass\UniTest.Sass.csproj (in 1.5 sec).
Restored C:\Users\Argo\src\BootstrapBlazor\test\UnitTest.Localization\UnitTest.Localization.csproj (in 1.52 sec).
Restored C:\Users\Argo\src\BootstrapBlazor\test\UnitTestDocs\UnitTestDocs.csproj (in 1.53 sec).
Restored C:\Users\Argo\src\BootstrapBlazor\test\UnitTest\UnitTest.csproj (in 1.56 sec).
Restored C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\BootstrapBlazor.csproj (in 1.75 sec).
1>------ Rebuild All started: Project: BootstrapBlazor, Configuration: Debug Any CPU ------
1>  BootstrapBlazor -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\bin\Debug\net8.0\BootstrapBlazor.dll
1>  BootstrapBlazor -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\bin\Debug\net7.0\BootstrapBlazor.dll
1>  BootstrapBlazor -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\bin\Debug\net9.0\BootstrapBlazor.dll
1>  BootstrapBlazor -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\bin\Debug\net6.0\BootstrapBlazor.dll
1>  BootstrapBlazor -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor\bin\Debug\net10.0\BootstrapBlazor.dll
2>------ Rebuild All started: Project: BootstrapBlazor.Server, Configuration: Debug Any CPU ------
2>  BootstrapBlazor.Server -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\bin\Debug\net10.0\BootstrapBlazor.Server.dll
2>  [IP2Region] Copy xdb file -> C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\bin\Debug\net10.0\
2>  LLMs documentation generating ...
2>  Tool 'bootstrapblazor.cssbundler' (version '10.0.0') was restored. Available commands: css-bundler
2>  Tool 'bootstrapblazor.llmsdocsgenerator' (version '10.0.0') was restored. Available commands: llms-docs
2>
2>  Restore was successful.
2>  Root path: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\
2>  Source path: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor
2>  Output path: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms
2>  Analyzing components...
2>  Found 219 components
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms.txt
2>  Generating table documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-table.txt
2>  Generating input documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-input.txt
2>  Generating select documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-select.txt
2>  Generating button documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-button.txt
2>  Generating dialog documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-dialog.txt
2>  Generating nav documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-nav.txt
2>  Generating card documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-card.txt
2>  Generating treeview documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-treeview.txt
2>  Generating form documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-form.txt
2>  Generating other documentation...
2>  Generated: C:\Users\Argo\src\BootstrapBlazor\src\BootstrapBlazor.Server\wwwroot\llms\llms-other.txt
2>  Documentation generation complete!
========== Rebuild All: 2 succeeded, 0 failed, 0 skipped ==========
========== Rebuild completed at 21:18 and took 34.095 seconds ==========

[ice6]

@ArgoZhang 你说的对，文档每个组件的文档尾部那个参数组件应该用类似方法实现。

最新代码已经修改为：components/{Component}.txt 模式，llms.txt这里做了分组。

我也有个小小感悟：组件多是一个特色，质量更好、更加易用会更上一层楼。

期待组件库越做越好，新的一年，加油！

[ArgoZhang]

@ice6 PR 合并 工程移动到扩展库，后续更新从那边更新 https://github.com/BootstrapBlazor/BootstrapBlazor.Extensions/tree/master/tools/BootstrapBlazor.LLMsDocsGenerator

[ArgoZhang]

@ice6 hi. good news. https://www.blazor.zone/llms.txt is online now.

you can visit https://www.blazor.zone/llms/components/Alert.txt too.

now. you can PR introduce page or improve BootstrapBlazor.LLMsDocsGenerator tool

[ice6]

So, cool! a small step, llms big forward. :P

[ice6]

@j4587698 这个问题比较好的被解决了，前面讲话不礼貌，不好意思哈。🤗 🤝🫂