docsector-reader
活跃·★ 21·MIT·更新于 2026-05-29
★ 时下流行★ RAG / 知识库★ 开发者工具
一个基于 Vue 3、Quasar v2 和 Vite 构建的文档渲染引擎，可将 Markdown 内容转换为美观、可导航的文档站点。
Docsector Reader 是一个基于 Vue 3、Quasar v2 和 Vite 构建的文档渲染引擎。它将 Markdown 内容转换为美观、可导航的文档站点，具备国际化、语法高亮、暗色/亮色模式、锚点导航等功能。该引擎提供了 AI 友好特性，包括 Markdown 内容协商、MCP 服务器、机器人检测以及多种发现端点。
#人工智能#ai-friendly#AI 工具#anchor-navigation#builder#文档#examples#guide
01
功能特性
01Markdown 渲染，支持语法高亮（Prism.js）、Mermaid 图表、KaTeX 数学公式、GitHub 风格提示以及原始 HTML。
02国际化（i18n）支持，每页可单独翻译，使用 HJSON 本地化文件。
03暗色/亮色模式、锚点导航、搜索、响应式设计以及可展开的 Markdown 部分。
04AI 友好特性：Markdown 内容协商、llms.txt、MCP 服务器、WebMCP 浏览器工具、网络机器人认证和内容信号。
05通过单个 `docsector.config.js` 文件进行配置，并提供 CLI 工具用于脚手架搭建、开发和构建。
02
兼容性
Vue
Vue 3 (组合式 API)
已通过文档验证
Quasar
Quasar v2 (UI 框架)
已通过文档验证
Vite
Vite (构建工具，通过 @quasar/app-vite)
已通过文档验证
03
快速开始
1
$ npm install @docsector/docsector-reader
2
$ npx docsector init my-docs
3
$ cd my-docs
4
$ npm install
04
使用场景
↳为开源项目或内部工具创建美观的文档网站。
↳构建 AI 友好的文档，向大语言模型提供原始 Markdown，并为 AI 助手提供 MCP 集成。
↳生成支持国际化、版本管理和搜索功能的多语言文档。
05
同类工具
相关搜索
评论
登录后发表评论
暂无评论，来发表第一条吧