https://github.com/ahelmy/docusaurus-ai

This is a simple AI assistance for Docusaurus generated documentation. It is a simple chatbot that can answer questions about your docs.
https://github.com/ahelmy/docusaurus-ai

ai ai-assistant documentation docusaurus llm plugin react

Last synced: about 2 months ago
JSON representation

This is a simple AI assistance for Docusaurus generated documentation. It is a simple chatbot that can answer questions about your docs.

• Host: GitHub
• URL: https://github.com/ahelmy/docusaurus-ai
• Owner: ahelmy
• Created: 2024-12-26T22:26:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-07T15:34:04.000Z (about 1 year ago)
• Last Synced: 2025-11-22T14:13:49.599Z (3 months ago)
• Topics: ai, ai-assistant, documentation, docusaurus, llm, plugin, react
• Language: TypeScript
• Homepage:
• Size: 1.35 MB
• Stars: 38
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Docusaurus AI assisstance

This is a simple AI assistance for Docusaurus generated documentation. It is a simple chatbot that can answer questions about your docs.

## Screenshots

![Screenshot](./assets/screenshots/demo.png)

## Architecture

![Architecture](./assets/architecture.png)

## Installation

To install the AI assisstance, you need to clone the repository and install the dependencies. You can do this by running the following commands:

```bash

git clone https://github.com/ahelmy/docusaurus-ai.git

cd docusaurus-ai

yarn install

```

## Run on Docker

1. Run `touch .env` add environment variable for Google Gemine API key if you want, otherwise comment out line 22-26 in `docker-compose.yml`.

2. Run `docker-compose up -d ollama` and wait to be ready.

3. Run `docker-compose exec ollama bash -c "ollama pull llama3.2:1b"` and wait to be ready.

4. Run `docker-compose up -d --build`

5. Open your browser and navigate to `https://docusaurus-ai.localhost` and test the AI assistant.