Free & unlimited Ask AI widget for your Docusaurus docs (for public open-source projects only)

[ivictbor]

To support Open-Source Projects we implemented free & unlimited Ask AI Widget for Docusaurus docs, free proposal is always eligible for any open-source public projects hosted on GitHub.

Installation is very simple, all you need to do is add the minimal script to your Docusaurus project:

window.tlumaConfig = {
  source: "devforth/adminforth", // public GitHub project which has your Docusaurus docs (e.g. in some subfolder), use GitHub "org/repo" or "owner/repo"
};
</script>
<script src="https://tluma.ai/widget.js" async></script>

All your .md/.mdx files which exist in a repo will be used as a context.

Docs are always auto-indexed from default branch with a daily auto-update.

You can also use Tluma Widget Configurator or login to tluma admin to see your project stats and read sessions.

Live demo link https://adminforth.dev/ (check Ask AI bottom at bottom right corner)

Would love to hear your feedback!

[Indu34569]

This is really cool —thanks for sharing!

The setup looks helpful , super simple, and it seems like it could make Docusaurus docs much easier to use.

A small question: does this work with private repositories, or is it only for public open-source projects?

Also, if you have a demo link, I’d love to check it out.

Thanks , once again!

[Indu34569]

A suggestion :
Maybe adding support for customization options would be helpful.

[ivictbor]

@Indu34569 thanks a lot for a feedback

does this work with private repositories, or is it only for public open-source projects?

Tluma can be installed to any website for free (does not matter website code is private or public), but for now it is able to fetch knowledge only from public repositories as an initiative to support Open-Source software projects which are public on GitHub. So basic idea that maintainers of any kind of open-source software can install it on Docusaurus website and allow their users to increase activation, onboard faster, and get quick answers to their question (like "how to do this", "does this project can do that", "give me minimal setup code for xx" and so on). Without payments for LLM or any infrastructure.

For private repo owners there is a simple trick - you can extract docs (.md/.mdx/.rst files) to a new public repo and keep your main product code in privet repo, and Tluma will index this public repo. Then install Tluma widget to any website you wish. This is common practice because docs which power Docusaurus after deployment are anyway getting public, so publishing docusaurus website is not an issue generally.

Also, if you have a demo link, I’d love to check it out.

Thanks, indeed, added into main post

adding support for customization options would be helpful

Thanks, we have live widget configurator which already have options with live preview like brand color, button position, edge padding and many more, you can check it and if you need any more options - please share the idea and we will quickly implemnenet it
To access config editor use this link https://tluma.ai/widget-config/devforth/adminforth , please replace devforth/adminforth with your public <github org>/<github repo>, you can also go to config editor by searching yoru public repo here https://tluma.ai/#ask-ai

[Indu34569]

Really appreciate your quick reply and thanks for the detailed explanation, makes sense and it helped a lot .

It’s great that it supports private websites while indexing public docs from GitHub—that’s a smart approach for open-source projects.

Also nice to know about the widget configurator, I’ll try it out and explore the customization options.

If I have more suggestions, I’ll share them here 🙂