For ReadMe

Ask AI for your ReadMe docs

Add an Ask AI chatbot or AI search widget to your ReadMe docs. Readers ask questions in plain language and get source-cited answers from your guides, API reference, and changelog. Business and Enterprise plans only.

Start free trial See the install code

14-day freeSelf-serveLive in 15 min

Biel.ai chatbot

Assistant

Hi! how can I help you?

Three ways to ship Biel on ReadMe

A floating Ask AI chatbot via Custom JavaScript, an AI search field next to ReadMe search, or a hosted MCP endpoint Claude and Cursor can query directly.

Full installation guide

Inject 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);
})();

Add AI search alongside ReadMe search

The same Custom JavaScript hook can mount <biel-search-button> next to ReadMe’s built-in search. ReadMe’s search is good for keyword lookup; Biel handles the natural-language questions readers actually ask.

→AI search field in the navbar
→Returns synthesized answer, not a list
→Coexists with ReadMe's built-in search
→Same Custom JS injection point

ReadMe Custom JavaScript

(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-search-button');
    btn.setAttribute('project', '<YOUR_PROJECT_ID>');
    btn.setAttribute('header-title', 'Documentation AI');
    btn.setAttribute('button-style', 'rounded');
    btn.textContent = 'Search';

    // Place near the ReadMe search input
    var nav = document.querySelector('.rm-Header') || document.body;
    nav.appendChild(btn);
  };
  document.head.appendChild(script);
})();

Make your docs queryable by AI agents

Every Biel project ships with a hosted MCP endpoint. Claude, Cursor, Cline, and other MCP-compatible assistants can search your ReadMe docs directly. Configure once in mcp.json.

→Hosted MCP server, no self-hosting
→Same index as the chatbot, one source of truth
→Works with Claude Desktop, Cursor, Cline, Zed
→Auth via project token, scoped per-workspace

mcp.json

{
  "mcpServers": {
    "biel-ai": {
      "name": "Biel.ai",
      "type": "http",
      "url": "https://mcp.biel.ai/v2/YOUR_PROJECT_SLUG/mcp"
    }
  }
}

Biel.ai vs ReadMe built-in search

ReadMe's search is solid for keyword lookup against API reference and guides. Biel is built for natural-language questions, with awareness of endpoints, versioned projects, and the changelog. 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.	Natural-language questions. Returns a synthesized answer with source citations.
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.	Per-version indexes. Scope answers to the user's current version automatically.
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. Live in 15 minutes.
Cost	Included with ReadMe.	From $50/mo, self-serve. 14-day free trial, no credit card required.

Things teams ask during evaluation

Which ReadMe plans does it work with?

Custom JavaScript is a Business and Enterprise plan feature on ReadMe. The widget install requires it. Free and Startup plans can use Biel by hosting their docs site separately and indexing the public ReadMe URL.

Does it understand our API reference?

Yes. Endpoint pages, parameter docs, request and response shapes are indexed as documentation. Citations resolve to the right endpoint anchor, so readers see exactly which endpoint the answer came from.

Will it work with versioned projects?

Yes. Each version your ReadMe project publishes is indexed as its own source. Readers on /v1.0/ do not get answers from /v2.0/.

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. Biel sits alongside as a separate widget for natural-language questions. Many ReadMe sites run both.

How long does the install take?

One Custom JavaScript field. Most teams are live in 15 minutes including indexing.

Where does our content go?

EU-hosted by default. GDPR compliant. Your content is never used to train models.

Make your ReadMe docs answer questions

Start free trial Book a demo

14-day free trial · No credit card required · From $50/mo

Use a different platform? See our integration pages for Paligo, Document360, Docusaurus, MkDocs, and Sphinx.