# eleventy-plugin-nav-menu

> A responsive nav menu shortcode for Eleventy

Latest version **0.0.1** (published 2021-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install eleventy-plugin-nav-menu
pnpm add eleventy-plugin-nav-menu
yarn add eleventy-plugin-nav-menu
bun add eleventy-plugin-nav-menu
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-01-26 |
| First published | 2021-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sean McPherson |
| Maintainers | seanmcp |
| Keywords | eleventy-plugin, eleventy, nav-menu, navigation, menu |

## Links

- npm: https://www.npmjs.com/package/eleventy-plugin-nav-menu
- Repository: https://github.com/SeanMcP/eleventy-plugin-nav-menu
- Homepage: https://github.com/SeanMcP/eleventy-plugin-nav-menu#readme
- Issues: https://github.com/SeanMcP/eleventy-plugin-nav-menu/issues
- npm.io page: https://npm.io/package/eleventy-plugin-nav-menu

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2021-01-26

## README

# `eleventy-plugin-nav-menu`

[![npm](https://img.shields.io/npm/v/eleventy-plugin-nav-menu.svg)](https://npmjs.com/package/eleventy-plugin-nav-menu) [![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/eleventy-plugin-nav-menu.svg)](https://npmjs.com/package/eleventy-plugin-nav-menu) [![npm](https://img.shields.io/npm/dt/eleventy-plugin-nav-menu.svg)](https://npmjs.com/package/eleventy-plugin-nav-menu)

⛵️ A responsive nav menu shortcode for Eleventy

## Install

```sh
npm install eleventy-plugin-nav-menu
```

## Usage

```js
const navMenuPlugin = require('eleventy-plugin-nav-menu');

module.exports = function(eleventyConfig) {
    eleventyConfig.addPlugin(navMenuPlugin)

    return { /* ... */ }
}
```

The plugin adds three shortcodes: 

- `navMenu`: A chunk of html
- `navMenuStyles`: Minimal (and minified) styles
- `navMenuScript`: Minified JavaScript

Add them to your layout like so:

```html
<!DOCTYPE html>
    <head>
        {% navMenuStyles %}
    </head>
    <body>
        <!-- Use with @11ty/eleventy-navigation is optional -->
        {% navMenu collections.all | eleventyNavigation %}
    </body>
    {% navMenuScript %}
</html>
```

## Warning

This library is a work in progress. Expect changes before `v1.0.0` release. Use at your own risk.

## License

MIT © [Sean McPherson](https://seanmcp.com)

---
_Source: https://npm.io/package/eleventy-plugin-nav-menu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._