murmur-rag weekly downloads statistics

murmur

Site & live demo · Guide · Playground · npm

An AI chat bubble for any website that answers from the site's own pages, cites them and links to the right heading. One script tag, no backend, the model you pick through llm-connect. Works on GitHub Pages.

<script type="module" src="https://maxgfr.github.io/murmur/cdn/murmur.js"></script>

The widget

Paste the line before </body>. Without options, the bubble answers from the page the visitor is on, with a small model running in the visitor's browser (after they agree to a one-time 1.1 GB download); visitors can connect their own AI key instead from the AI settings. The configurator writes the line for you.

Attribute
data-index	URL of the index written by murmur index (/murmur-index.json). Without it, the current page is read
data-endpoint	Your OpenAI-compatible proxy (https): visitors chat without a key
data-mode, data-preload	Who answers (proxy, local, auto, key) and when the in-browser model downloads (question, open, idle, consent)
data-local	false turns off the in-browser model, the default when there is no proxy: visitors then need their own key
data-provider, data-model	Provider and model preselected for visitors, or the model asked of the proxy
data-instructions	Your instructions to the assistant
data-title, data-greeting, data-placeholder, data-button	Texts of the panel
data-lang	en or fr (default: the page's lang, then the browser's)
data-position	bottom-right (default) or bottom-left
data-accent, data-theme	Any CSS colour; auto, light or dark
data-open, data-storage-key	Open on load; prefix of what the widget stores

The widget lives in a Shadow DOM and is restyled through --murmur-accent, --murmur-accent-ink, --murmur-font, --murmur-radius and --murmur-z. It emits murmur:state events (searching, streaming, done, error) with the passages found and cited.

Index your site

npx murmur-rag index ./dist --out ./dist/murmur-index.json

Reads every .html, .md and .txt file (or a live sitemap.xml), keeps the content of main / article / body, skips navigation, headers, footers, forms, scripts and anything marked data-murmur-ignore, and cuts pages into passages under their headings. Options: --base (URL prefix), --root, --exclude, --max-chunk.

AI models and keys

Pick who answers with data-mode. A key in a web page can be read by anyone, so murmur never takes one: yours stays in your Worker, a visitor's in their own browser.…