技能潮 SkillTide 提交收录
官方说明开源项目7 天前
dgesteves/ondocs

dgesteves/ondocs

Make your docs answerable by people and by agents, from one static index: a cited Ask box, an MCP server and llms.txt, on your own function and key, with no vector database and no vendor. Docusaurus and Starlight plugins, Next.js, or one script tag.
在 GitHub 查看 ↗直链 · 无中转页
★ 数取值
1 ★ · dgesteves/ondocs · 取自该仓库的 GitHub 页面 · (2026-10-16 20:00:20 核对)
来源明细
从该仓库的 GitHub 页面直接读取 · 条目类型:开源项目
收录与活跃
收录于 2026-10-10 · 最近见到 2026-10-10 · 共见到 2 次 · 被 1 个来源列出
评分构成
综合分 103 · 1 ★ · 1 个来源 · repo
安装
npx ondocs
常见问题(答案都来自我们的记录)
怎么安装?
该仓库给出的安装命令是 npx ondocs。我们的记录里它是仓库自己提供的;不保证在你的客户端上直接可用。
它适合谁 / 用来做什么?
我们把它归在这些标签下: 开源项目。标签来自条目自身,不是我们强加的分类。
谁维护它、还在更新吗?
仓库 dgesteves/ondocs;我们收录于 2026-10-10;最近见到 2026-10-10。这里没有"官方认证"或"质量评级"——我们只记录来源与时间。
第三方质量标记

ondocs

以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →

**Open-source Ask AI for your docs.** Cited answers on your own model key, and an MCP server for coding agents, from one index built with your Starlight, Docusaurus or VitePress site. No vendor, no vector database.
For teams that run their own developer docs, at product, API and platform companies, who want Ask AI without a hosted assistant.
**Answers with**
**Ask these docs from your editor**, over this site's MCP server:
**Website: ondocs.vercel.app**, whose docs answer with OpenAI and serve agents at /api/mcp. Formerly ask-my-site (what changed).
https://github.com/user-attachments/assets/2491c5ea-de70-471c-b11e-30591c074e6f
The live demo : a streamed answer with citations, one opening the section it came from, then the one-line setups.
The live demo : a streamed answer with citations, one opening the section it came from, then the one-line setups.
-->
What you get
One index, ask-index.json, built with your site, feeds three things:
- **An Ask box for people.** A ⌘I dialog that streams a short answer from your model, with numbered citations to the exact section. Most off-topic questions get "I don't know" before the model is called. A page loads only the button; the dialog loads on first use.
- **An MCP server for agents.** search, fetch and list_pages over the same index, for coding agents and ChatGPT. Agents bring their own model, and keyword search, the default, calls no model at all.
- **llms.txt, llms-full.txt and a .md copy of every page**, written with the build.
Search runs in memory inside one function you deploy: BM25 and vectors, merged with reciprocal rank fusion.
Pick your setup
| Your site | What you add | Guide |
| ---------------------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
| Starlight, or any Astro site | A plugin, or an integration | Astro and Starlight |
| Docusaurus 3 | A plugin | Docusaurus |
| VitePress | One wrapper in its config | VitePress |
| Next.js or another React app | A route and a component | Next.js and React |
| Fumadocs | A route and a component | Fumadocs |
| Nextra | A route and a component | Nextra |
| Hugo, Jekyll, MkDocs or plain HTML | One script tag; for plain HTML, init --out | Script tag |
Each answers from an endpoint you deploy as one function next to the site, rate-limited by default. npx ondocs init writes it for Vercel, Netlify, Cloudflare or GitHub Pages (as a Worker answering with Workers AI, no API key): see Deploying.
**Live demos:** Starlight, Docusaurus, VitePress.
**Starlight.** npm i ondocs ai @ai-sdk/openai react react-dom @radix-ui/react-dialog cmdk, then:
After astro build, it indexes the pages into dist/ask-index.json, writes llms.txt and the .md pages, and adds an "Ask AI" button with ⌘I. Static site? npx ondocs init. SSR adapter? Nothing to do.
**Docusaurus.** npm i ondocs ai @ai-sdk/openai @radix-ui/react-dialog cmdk, then:
It does the same after docusaurus build, into build/.
**Next.js.** With OPENAI_API_KEY set, index your content with npx ondocs index ./content --base-url /docs --llms-txt public, then:
and render the dialog in your layout, with its two stylesheets:
**Any other site.** Index the HTML it builds, write the endpoint with npx ondocs init, and add the script tag:
On a GitHub Pages project site, at https://user.github.io/repo, add --base-url /repo to the index command.
来源
github · https://github.com/dgesteves/ondocs
按领域浏览
开源项目
Traction
1 ★
收录于
7 天前

更多开源项目

查看开源项目全部 731 条 →

所属领域与标签

每个标签都能点进去看同类的全部条目。数字是当前库里的真实条数。

浏览全部领域 →

← 返回索引