Skip to main content

AI chatbot for Jekyll

Here's a step-by-step guide to help you install Biel.ai in your Jekyll project.

Chatbot wiget for docs

Prerequisites​

Before you begin, you'll need to have the following:

  • A Biel.ai account. If you don't have one, sign up for free.
  • A project created in your Biel.ai dashboard. If you haven't created one yet, follow the steps in the Quickstart guide.
  • A Jekyll project.

Installation​

To integrate the Biel.ai widget into your Jekyll site:

  1. Open your terminal or command prompt. Navigate to your project's root directory using the cd command:

    cd path/to/your/project

    Replace path/to/your/project with your project's actual directory path.

  2. Open the _includes/head.html file (or the equivalent file that contains the <head> section in your Jekyll theme). Append the following code:

    <!-- Initialize the Biel.ai widget -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.css">
    <script type="module" src="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.esm.js"></script>

  3. Open _includes/footer.html or the specific file where you'd like the chatbot to appear. Add the following snippet just before its closing tags:

    <biel-button project="<YOUR_PROJECT_ID>" 
        header-title="Biel.ai chatbot"
        button-position="bottom-right"
        modal-position="bottom-right"
        button-style="dark">
            Ask AI
    </biel-button>

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

  4. After making these changes, navigate back to your Jekyll project root and run:

    jekyll build

    Once it builds successfully, verify that the chatbot appears and functions correctly on your site.

Next steps​

For more about customization and additional features exploration, check out the customization section.

Need assistance? We're here to help! Reach out to us at Biel.ai Support.