WP Algolia Search Addons

WP Algolia Search Addons is an experimental extension for the WP Search with Algolia plugin, available on WordPress.org. This add-on seamlessly connects Algolia with popular plugins like Polylang and WP2Static, enhancing search functionality and improving user experience.

Table of Contents

1. Features
2. Prerequisites
3. Installation
4. FAQ
5. Contributing
6. Changelog
7. License
8. Acknowledgements

Features

• Exclude Pages from Indexing: Allows exclusion of specific pages from being indexed by Algolia, offering greater control over search results.

• Polylang Integration: Integrates with Polylang to deliver locale-specific search results and suggestions, ensuring a tailored user experience for multilingual websites.

  1. Locale Attributes: Integrates Polylang locale attributes for locale-based search filtering
  2. Language-Specific Search: Delivers search results relevant to user's selected language
  3. Faceted Search by Locale: Enables locale-based faceted search for refined results
  4. Autocomplete with Locale: Provides locale-filtered autocomplete suggestions for multilingual users

• WP-to-Static Support:

  1. URL Rewrite: Rewrites site URLs with deployment URLs for static site generation.

Prerequisites

• WordPress 5.0 or higher
• WP Search with Algolia plugin
• Polylang plugin (for multilingual support)

Installation

1. Download the Plugin: Clone or download the repository to your local machine.

   git clone https://github.com/yourusername/wp-algolia-search-addons.git

2. Upload to WordPress: Upload the plugin folder to the /wp-content/plugins/ directory.

3. Activate the Plugin: Activate the plugin through the 'Plugins' menu in WordPress.

4. Configure Algolia: Ensure you have the WP Search with Algolia plugin installed and configured. Index your searchable posts.

5. Configure Polylang: Ensure you have the Polylang plugin installed and configured for multilingual support.

Configuration

Once the plugin is installed and activated, navigate to the settings page by selecting Settings > Algolia Search Addons from the left-hand menu in the WordPress Admin dashboard. Here, you can configure the plugin to suit your specific needs.

FAQ

Q: Does this plugin support other multilingual plugins? A: Currently, it supports Polylang. Support for other plugins may be added in the future.

Contributing

We are thrilled to have you consider contributing to the WP Algolia Search Addons plugin! Your involvement is key to the success and improvement of this project. Here are some ways you can get involved:

• Reporting Bugs: Encountered a bug or an issue? Please let us know by opening an issue on our GitHub repository. Your feedback helps us make the plugin better for everyone.
• Submitting Pull Requests: Have a fix or a new feature in mind? We welcome your Pull Requests with open arms. Your contributions are highly valued and appreciated.
• Sponsoring the Project: Love what we're doing? You can support the ongoing development by sponsoring us on Ko-fi. Your generosity helps us dedicate more time and resources to the project.

Thank you for your interest and support. Together, we can make WP Algolia Search Addons even better!

Changelog

For detailed release notes, see the CHANGELOG file.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

• Thanks to the WP Search with Algolia and Polylang teams for their amazing plugins.
• Special thanks to all contributors and users who have provided feedback and suggestions.