Skip to content

TechDocsStudio/starlight-biel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI chatbot plugin for Starlight

Ask AI chatbot plugin for Starlight sites, powered by Biel.ai.

AI chatbot Starlight

Add an AI chatbot to your Starlight documentation using Biel.ai's plugin. The integration adds both chat and search capabilities to your site. No component overrides needed.

Note: A Biel.ai plan is required to use this plugin. Try it free for 14 days—no credit card required.

Key features

  • AI chatbot that provides instant responses to documentation queries.
  • AI search engine for quick and relevant information retrieval.
  • Native Starlight plugin, no component overrides required.
  • Customizable to match your site's branding and user needs.

Installation

npm install starlight-biel

Add the plugin to your astro.config.mjs:

import { defineConfig } from 'astro/config'
import starlight from '@astrojs/starlight'
import starlightBiel from 'starlight-biel'

export default defineConfig({
  integrations: [
    starlight({
      title: 'My Docs',
      plugins: [
        starlightBiel({
          project: '<YOUR_PROJECT_ID>',
          headerTitle: 'Biel.ai chatbot',
        }),
      ],
    }),
  ],
})

Replace <YOUR_PROJECT_ID> with your project's ID from the Biel.ai dashboard.

Run npm run dev and verify the chat button appears in the bottom-right corner.

Configuration

All widget options are supported as camelCase keys, for example:

starlightBiel({
  project: '<YOUR_PROJECT_ID>',
  bielButtonText: 'Ask AI',
  buttonPosition: 'bottom-right',
  modalPosition: 'bottom-right',
  buttonStyle: 'dark',
  headerTitle: 'Documentation AI',
})

Set enable: false to turn the widget off without removing the configuration.

Get started

See the Starlight AI chatbot integration guide for the full list of options and setup instructions.

Support

Need assistance? Contact us for help.

License

Copyright (c) 2024 Biel.ai

Licensed under the MIT License.

Releases

No releases published

Packages

 
 
 

Contributors