stillat/documentation-search

v1.2.1 2024-12-03 23:11 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-libxml: *
• ext-mbstring: *
• laravel/pint: ^1.13
• statamic/cms: ^4 || ^5
• stillat/statamic-template-resolver: ^1.1

Requires (Dev)

• orchestra/testbench: ^8.14 || ^9
• pestphp/pest: ^2.24
• pestphp/pest-plugin-laravel: ^2.2

MIT

README

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:

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.

License

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