Skip to content
Snippets Groups Projects

Issue #3341792: Update README.md file as per standard

+ 37
25
# Smartmenus jQuery Plugin - Drupal module
# Smartmenus.js
This module provides Drupal integration with the Smartmenus.js advanced jQuery
website menu plugin. Mobile first, responsive and accessible list-based website
menus that work on all devices. This is the library that was included in core
for BackdropCMS, and is most commonly used with Bootstrap.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/smartmenus).
## INSTALLATION
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/smartmenus).
1) Install the Smartmenus jQuery plugin.
## Table of contents
- Requirements
- Installation
- Configuration
- Maintainers
## Requirements
This module requires the following modules:
- [Smartmenus jQuery Plugin](https://www.smartmenus.org)
## Installation
1. Install the Smartmenus jQuery plugin.
Smartmenus library is added using composer.
Add this to your project's composer.json:
```
```json
"repositories": [
{
"type": "package",
@@ -33,30 +54,21 @@ for BackdropCMS, and is most commonly used with Bootstrap.
}
],
```
2. Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
2) Install the Smartmenus module as usual (see below)
http://drupal.org/project/smartmenus
## USAGE
1) Navigate to the blocks administration at admin/structure/blocks
2) Place the Responsive Main Menu (Smartmenus) block into a region
3) Select necessary options from the block configure form.
4) Check the UI.
## REQUIREMENTS
- Smartmenus jQuery Plugin (https://www.smartmenus.org)
## Configuration
## MAIN CONTRIBUTORS
1. Navigate to the blocks administration at _admin/structure/blocks_
2. Place the Responsive Main Menu (Smartmenus) block into a region
3. Select necessary options from the block configure form.
4. Check the UI.
- jQuery Plugin created by Vasil Dinkov (https://github.com/vadikom)
- Drupal 7 module created by Jen Lampton (http://drupal.org/user/85586)
## Maintainers
- Drupal 8 module ported by Vishwa Chikate (https://www.drupal.org/user/2857973)
- Jen Lampton - [jenlampton](https://www.drupal.org/u/jenlampton)
- Doug Green - [douggreen](https://www.drupal.org/u/douggreen)
- Vishwa Chikate - [vishwac9](https://www.drupal.org/u/vishwac9)
Loading