Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blaketarter/generator-one-pager
Yeoman Generator for quick one-pager websites
https://github.com/blaketarter/generator-one-pager
Last synced: 24 days ago
JSON representation
Yeoman Generator for quick one-pager websites
- Host: GitHub
- URL: https://github.com/blaketarter/generator-one-pager
- Owner: blaketarter
- License: mit
- Created: 2015-03-27T05:43:12.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-08T20:47:16.000Z (about 9 years ago)
- Last Synced: 2024-11-16T15:38:44.212Z (about 2 months ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generator One Pager [](http://badge.fury.io/js/generator-one-pager) [](https://travis-ci.org/blaketarter/generator-one-pager) [](https://david-dm.org/blaketarter/generator-one-pager)
A [Yeoman](http://yeoman.io) generator for quickly scaffolding a static one page website. Useful for things like landing pages and coming soon pages.
## Dependencies
* [Yeoman](http://yeoman.io): `npm install -g yo`
* [Grunt](http://gruntjs.com/): `npm install -g grunt-cli`
## Installation
To install and use this generator simply run `npm install -g generator-one-pager`.
## Usage
Running this generator is as easy as typing `yo one-pager`.
It has plenty of options to get the build to your taste, but all versions use [Jade](http://jade-lang.com/) as the html templating engine.
#### Included
These libraries/extensions/tasks are included in every build.
* [Modernizr](http://modernizr.com/)
* [SCSS](http://sass-lang.com/)
* [Autoprefixer](https://github.com/postcss/autoprefixer)
* [Normalize.css](https://necolas.github.io/normalize.css/)
* [Jade](http://jade-lang.com/)
* [Imagemin](https://github.com/imagemin/imagemin)
* [JSHint](http://jshint.com/)
* [Livereload](http://livereload.com/)
* [HTML5shiv](https://github.com/aFarkas/html5shiv)
#### Options
The options which can be turned on or off are:
* Using [Compass](http://compass-style.org/)
* Using [Foundation](http://foundation.zurb.com/)
* Using [jQuery](https://jquery.com/)
* Using [Outdated Browser](http://outdatedbrowser.com/)
* Using [Google Analytics](http://www.google.com/analytics/)
#### Project Structure
The Structure of this app is a a little opinionated to my current workflow but currently looks like this:
```
one-pager
|-- dist
|-- src
| |-- index.jade
| |-- images
| |-- yo.png
| |-- js
| |-- scripts.js
| |-- partials
| |-- _header.jade
| |-- scss
| |-- components
| |-- _footer.scss
| |-- _global.scss
| |-- _manifest.scss
| |-- _navbar.scss
| |-- _typography.scss
| |-- _variables.scss
| |-- pages
| |-- index
| |-- _content.scss
| |-- _manifest.scss
| |-- _manifest.scss
| |-- vendor
| |-- _manifest.scss
| |-- _normalize.scss
| |-- styles.scss
```
#### Page Sub-Generator
There is a `:page` sub-generator that is available to use that can generate additional pages (then its no longer a one pager I guess).
To use it is as simple as `yo one-pager:page`. It will then ask for the pages name and then create the scss file and jade file for that page.
#### Gruntfile
So far the only grunt command is `grunt default` or simply `grunt`, which builds it out then starts and connects to port `:9001` then watches for changes.
#### SCSS Structure
Currently one-pager is set up to use the manifest pattern, where every section of the scss structure is broken up semantically and all can be imported at once by simply importing the manifest file in every directory.
## Note
This is the first generator I've built and as such mistakes are expected, any feedback would be appreciated.
## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)