@brillout/docpress

Components: Algolia

Overview

This directory contains a custom components for integrating Algolia's search functionality into our application. The components here are tailored to meet our specific requirements, ensuring a seamless user experience.

Creation Process

The components/Algolia/ directory was created to address our need for a custom search implementation using Algolia Docsearch. Here’s a brief overview of how this directory was created:

1. Source Files: We sourced most of the files from Algolia's DocSearch repository, specifically extracting the base for our <Hit> component from their Results.tsx file, which includes the core rendering logic and styles.

2. Customization:

   • The components were modified to fit our needs. This included changing specific functionalities and adapting styles to match our application's design.
   • Most notably, we created a custom <Hit> component to tailor the display of search results.

3. Removal of Unused Code: We eliminated unnecessary parts of the original codebase that were not required and were incompatible with our implementation.

4. Minor adaptation:

   • While copying the original source code, we encountered issues with types that were not exported, requiring additional modifications to the components to ensure compatibility.

Changelog

0.7.6 (2024-10-03)

Bug Fixes

• add hotkey tooltip (35f57b7)
• improve hotkey label (007ff02)
• improve social links order (f001a0a)
• polish social link margins (b2479a7)

Features

• noSideNavigation: 'no-logo' (c31b59c)
• topNavigationStyle (8dcfbbc)