|
| 1 | +# Document Module for Magento 2 |
| 2 | + |
| 3 | +[](https://packagist.org/packages/opengento/module-document-search) |
| 4 | +[](./LICENSE) |
| 5 | +[](https://packagist.org/packages/opengento/module-document-search/stats) |
| 6 | +[](https://packagist.org/packages/opengento/module-document-search/stats) |
| 7 | + |
| 8 | +This module aims to make documents searchable for customers in Magento 2. |
| 9 | + |
| 10 | + - [Setup](#setup) |
| 11 | + - [Composer installation](#composer-installation) |
| 12 | + - [Setup the module](#setup-the-module) |
| 13 | + - [Features](#features) |
| 14 | + - [Settings](#settings) |
| 15 | + - [Documentation](#documentation) |
| 16 | + - [Support](#support) |
| 17 | + - [Authors](#authors) |
| 18 | + - [License](#license) |
| 19 | + |
| 20 | +## Setup |
| 21 | + |
| 22 | +Magento 2 Open Source or Commerce edition is required. |
| 23 | + |
| 24 | +### Composer installation |
| 25 | + |
| 26 | +Run the following composer command: |
| 27 | + |
| 28 | +``` |
| 29 | +composer require opengento/module-document-search |
| 30 | +``` |
| 31 | + |
| 32 | +### Setup the module |
| 33 | + |
| 34 | +Run the following magento command: |
| 35 | + |
| 36 | +``` |
| 37 | +bin/magento setup:upgrade |
| 38 | +``` |
| 39 | + |
| 40 | +**If you are in production mode, do not forget to recompile and redeploy the static resources.** |
| 41 | + |
| 42 | +## Features |
| 43 | + |
| 44 | +This module aims to make documents searchable for customers in Magento 2. |
| 45 | +Documents can be searchable if their visibility is set to `search`. |
| 46 | + |
| 47 | +## Documentation |
| 48 | + |
| 49 | +You can change the full search behavior by using the collection modifier extension point. |
| 50 | +Add you own `Magento\Framework\Data\CollectionModifierInterface` implementation to the modifiers list of: |
| 51 | + |
| 52 | +`\Opengento\DocumentSearch\Model\Collection\CollectionModifier` |
| 53 | + |
| 54 | +Query parameters can be read through: `\Opengento\DocumentSearch\Model\QueryData` |
| 55 | + |
| 56 | +## Support |
| 57 | + |
| 58 | +Raise a new [request](https://github.com/opengento/magento2-document-search/issues) to the issue tracker. |
| 59 | + |
| 60 | +## Authors |
| 61 | + |
| 62 | +- **Opengento Community** - *Lead* - [](https://twitter.com/opengento) |
| 63 | +- **Thomas Klein** - *Maintainer* - [](https://github.com/thomas-kl1) |
| 64 | +- **Contributors** - *Contributor* - [](https://github.com/opengento/magento2-document-search/graphs/contributors) |
| 65 | + |
| 66 | +## License |
| 67 | + |
| 68 | +This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details. |
| 69 | + |
| 70 | +***That's all folks!*** |
0 commit comments