https://github.com/opengento/magento2-document-widget

This module aims to make documents searchable for customers in Magento 2.
https://github.com/opengento/magento2-document-widget

document-management magento magento-2 magento-extension magento-module magento-widget magento2 magento2-extension magento2-extension-free magento2-module php widget

Last synced: 6 months ago
JSON representation

This module aims to make documents searchable for customers in Magento 2.

• Host: GitHub
• URL: https://github.com/opengento/magento2-document-widget
• Owner: opengento
• License: mit
• Created: 2020-12-06T17:22:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T17:19:03.000Z (over 1 year ago)
• Last Synced: 2025-03-30T03:31:30.530Z (9 months ago)
• Topics: document-management, magento, magento-2, magento-extension, magento-module, magento-widget, magento2, magento2-extension, magento2-extension-free, magento2-module, php, widget
• Language: PHP
• Homepage: https://opengento.fr
• Size: 36.1 KB
• Stars: 2
• Watchers: 8
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Document Module for Magento 2

[![Latest Stable Version](https://img.shields.io/packagist/v/opengento/module-document-widget.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-widget)

[![License: MIT](https://img.shields.io/github/license/opengento/magento2-document-widget.svg?style=flat-square)](./LICENSE) 

[![Packagist](https://img.shields.io/packagist/dt/opengento/module-document-widget.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-widget/stats)

[![Packagist](https://img.shields.io/packagist/dm/opengento/module-document-widget.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-widget/stats)

This module aims to make documents searchable for customers in Magento 2.

 - [Setup](#setup)

   - [Composer installation](#composer-installation)

   - [Setup the module](#setup-the-module)

 - [Features](#features)

 - [Settings](#settings)

 - [Documentation](#documentation)

 - [Support](#support)

 - [Authors](#authors)

 - [License](#license)

## Setup

Magento 2 Open Source or Commerce edition is required.

### Composer installation

Run the following composer command:

```

composer require opengento/module-document-widget

```

### Setup the module

Run the following magento command:

```

bin/magento setup:upgrade

```

**If you are in production mode, do not forget to recompile and redeploy the static resources.**

## Features

This module aims to make documents available trhough the widgets in Magento 2.  

Documents can be available as a list or a link thanks to new dedicated widgets.

## Documentation

You can use one of the two available widgets:

- link

  - inline name

  - block image

  - block name

  - block image + name

- list by document type

  - image

  - name

  - image + name

## Support

Raise a new [request](https://github.com/opengento/magento2-document-widget/issues) to the issue tracker.

## Authors

- **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)

- **Thomas Klein** - *Maintainer* - [![GitHub followers](https://img.shields.io/github/followers/thomas-kl1.svg?style=social)](https://github.com/thomas-kl1)

- **Contributors** - *Contributor* - [![GitHub contributors](https://img.shields.io/github/contributors/opengento/magento2-document-search.svg?style=flat-square)](https://github.com/opengento/magento2-document-search/graphs/contributors)

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details.

***That's all folks!***