For ReadMe
Ask AI for your ReadMe docs
Add a page-search widget with Ask AI and a separate assistant to ReadMe. Readers can find guides and API pages or request a source-linked answer. Business and Enterprise plans only.
14-day free trialNo credit card required
Biel.ai assistant
Powered by biel.ai
Assistant
Hi! How can I help you?
What is Biel?
Assistant
Biel.ai turns your product docs into an AI assistant. Add an assistant to your website, give AI agents context from your docs, or build custom experiences with our API.
How to try Biel?
Assistant
Sign up and try Biel free for 14 days. Set it up yourself, connect your docs, and add the assistant to your site. Or request a demo and we’ll walk you through it.
Used by documentation and developer-experience teams
Install
Three ways to ship Biel on ReadMe
A floating Ask AI assistant via Custom JavaScript, a page-search field with an Ask AI handoff next to ReadMe search, or a hosted MCP endpoint Claude and Cursor can query directly.
Full installation guideInject via ReadMe Custom JavaScript
ReadMe Business and Enterprise plans expose a Custom JavaScript field in Settings → Appearance. Paste the Biel snippet there and the Ask AI button appears on every page in your ReadMe project: guides, reference, changelog, all of them.
- →Floating Ask AI button on every page
- →Indexes API reference, guides, and changelog
- →Per-project install: scope by ReadMe project
- →Compatible with all ReadMe themes
ReadMe Custom JavaScript
// Settings → Appearance → Custom JavaScript & CSS
(function() {
var link = document.createElement('link');
link.rel = 'stylesheet';
link.href = 'https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.css';
document.head.appendChild(link);
var script = document.createElement('script');
script.type = 'module';
script.src = 'https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.esm.js';
script.onload = function() {
var btn = document.createElement('biel-button');
btn.setAttribute('project', '<YOUR_PROJECT_ID>');
btn.setAttribute('header-title', 'Documentation AI');
btn.setAttribute('button-position', 'bottom-right');
btn.setAttribute('button-style', 'dark');
btn.textContent = 'Ask AI';
document.body.appendChild(btn);
};
document.head.appendChild(script);
})();Biel.ai vs ReadMe built-in search
ReadMe's search is solid for keyword lookup against API reference and guides. Biel adds its own page-search widget plus an Ask AI handoff to the assistant. Many ReadMe sites run both.
| Dimension | ReadMe search | Biel.ai |
|---|---|---|
| Query type | Keyword and title matching across guides and reference. Returns a list of pages. | Semantic page results, with Ask AI for natural-language questions and source-linked answers. |
| API reference handling | ReadMe's strength. Search indexes endpoint titles and parameter names well. | Reads endpoint descriptions, parameter docs, and request/response shapes as documentation. Cites specific endpoints. |
| Changelog and guides | All indexed in one keyword search. No question-shape awareness. | Same content, indexed for natural-language questions. Citations preserve which section the answer came from. |
| Multi-version docs | ReadMe supports versioned projects. Each version has its own search index. | Index published versions. Use separate projects when answers must stay within one version. |
| Languages | Single-language search per ReadMe project. | Answers in 60+ languages, including languages your docs are not written in. |
| Analytics | ReadMe analytics tracks page views and search queries. | Plus unanswered questions, satisfaction trends, and a Content Gaps view that updates daily. |
| Install | Built into ReadMe. No install required. | One Custom JavaScript field. Indexing time depends on site size. |
| Cost | Included with ReadMe. | Self-serve. 14-day free trial, no credit card required. |
Before you install
Which ReadMe plans does it work with?
The widget requires ReadMe’s Custom JavaScript feature on Business or Enterprise. Other plans can still have their public pages indexed for use through Biel on another site.
Does it understand our API reference?
Yes. Biel reads your published endpoint pages, including parameters and request and response examples, and links answers to the supporting pages.
Will it work with versioned projects?
Yes. Index the published URLs for the versions you need. Use separate projects when answers must stay within one version. Adding versions to one project does not automatically restrict answers by the reader’s current page.
Can it index our changelog?
Yes. ReadMe Changelog entries are indexed alongside guides and reference. Useful when readers ask "what changed in the latest release?".
Can we keep ReadMe's built-in search?
Yes. Keep ReadMe search, add Biel's page-search widget alongside it, or use only the Biel assistant. Ask AI can carry a Biel search query into the assistant.
How long does the install take?
Add the widget to ReadMe’s Custom JavaScript field. Indexing time depends on the size of the project.
Make your ReadMe docs answer questions
14-day free trial · No credit card required
Use a different platform? See our integration pages for Paligo, Document360, Docusaurus, MkDocs, and Sphinx.