https://github.com/stillat/documentation-search

Documentation Search provides a custom Statamic Search provider, targeted at documentation websites.
https://github.com/stillat/documentation-search

documentation search statamic statamic-addon

Last synced: 2 days ago
JSON representation

Documentation Search provides a custom Statamic Search provider, targeted at documentation websites.

• Host: GitHub
• URL: https://github.com/stillat/documentation-search
• Owner: Stillat
• License: mit
• Created: 2023-11-11T17:59:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-03T23:13:58.000Z (about 2 months ago)
• Last Synced: 2025-01-04T10:38:03.634Z (26 days ago)
• Topics: documentation, search, statamic, statamic-addon
• Language: PHP
• Homepage: https://stillat.com/documentation-search/v1/introduction-installation
• Size: 758 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![](.art/banner.jpg)

Documentation Search is a powerful search provider for Statamic. Documentation Search was developed with documentation-heavy websites in mind, and supports the following features:

1. Split larger entries into smaller sections that can be indexed independently

2. Customizable indexer content, built using either Antlers or Blade templates

3. A custom `documentation:results` Antlers tag, providing advanced features designed to work directly with the search provider

4. Advanced indexer transformers, allowing for customizations of both indexed content *and* user search queries. Perfect for implementing "close enough" searches, or supporting common misspellings.

## How to Install

You can install Documentation Search for Statamic by running the following command from the root of your project:

``` bash

composer require stillat/documentation-search

```

## Documentation

Documentation for Documentation Search can be found online at https://stillat.com/documentation-search/v1/introduction-installation

## License

Documentation Search is open-source software, released under the [MIT License](https://github.com/Stillat/documentation-search/blob/main/LICENSE.md).

## License

Documentation Search for Statamic is open-sourced software licensed under the MIT license.