Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mblode/burger

Burger - The minimal hamburger menu with fullscreen navigation.
https://github.com/mblode/burger

bower burger fullscreen-navigation gh-pages jekyll

Last synced: 6 days ago
JSON representation

Burger - The minimal hamburger menu with fullscreen navigation.

Host: GitHub
URL: https://github.com/mblode/burger
Owner: mblode
License: mit
Created: 2015-04-04T09:53:50.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2023-11-06T20:47:03.000Z (about 1 year ago)
Last Synced: 2025-01-20T05:20:16.536Z (13 days ago)
Topics: bower, burger, fullscreen-navigation, gh-pages, jekyll
Language: SCSS
Homepage: http://codepen.io/mblode/pen/qEGWwB
Size: 1.11 MB
Stars: 822
Watchers: 20
Forks: 45
Open Issues: 4
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

# Burger

Burger is a minimal hamburger menu with fullscreen navigation. It is created by mblode.

This project officially requires zero external bower dependencies. Woo-hoo!

## [Demo on Codepen](http://codepen.io/mblode/pen/qEGWwB)

## Screenshots

![Burger: Closed](http://i.imgur.com/eElVkQI.png)

![Burger: Opened](http://i.imgur.com/tI0ZeNw.png)

## Quick Start

Several quick start options are available:

- Install with npm: `npm install the-burger` (recommended).
- [Download the latest release](https://github.com/mblode/burger/archive/master.zip).
- Clone the repo: `git clone https://github.com/mblode/burger.git`.

if you have cloned the repo or downloaded from .zip, there are a few steps you must take within the terminal.

1. Change directory: `cd burger`.
2. Install node modules: `npm install`.
3. Install scss-lint Ruby gem: `gem install scss-lint`.
4. To run gulp server: `gulp`.
5. To run build process: `gulp build`.

## Running Github Pages

The gh-pages branch is built using Jekyll and must therefore be install with `gem install jekyll`.

1. Checkout in to gh-pages: `git checkout gh-pages`.
2. Install burger dependency: `bower install`.
3. Run jekyll: `jekyll serve`.
4. Open in browser: `localhost:4000/burger/`.

## What's Included

These are the files that are generated from `bower install burger`

```
.
├── README.md
├── bower.json
└── dist
├── css
│   ├── burger..min.css
│   └── burger.min.css.map
├── index.html
├── scripts
│   ├── burger.js
│   ├── burger.min.js.map
│   └── burger.min.js
└── sass
└── burger.scss
```

## Documentation

### HTML Markup

```

```

## Browser Compatibility

- Safari 6.1+

- IE 10+
- Firefox 29+
- Chrome 26+
- Opera 17+