https://github.com/sercaneraslan/grunt-github-pages-foldering
This Grunt plugin is create folders recursively for Github URL paths.
https://github.com/sercaneraslan/grunt-github-pages-foldering
folder-structure github-pages
Last synced: 8 months ago
JSON representation
This Grunt plugin is create folders recursively for Github URL paths.
- Host: GitHub
- URL: https://github.com/sercaneraslan/grunt-github-pages-foldering
- Owner: sercaneraslan
- License: mit
- Created: 2014-11-25T16:47:59.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-08T12:14:42.000Z (almost 10 years ago)
- Last Synced: 2024-04-14T07:19:13.216Z (almost 2 years ago)
- Topics: folder-structure, github-pages
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-github-pages-foldering
> This plugin is create folders recursively for Github Pages URL paths.
## Getting Started
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-github-pages-foldering --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-github-pages-foldering');
```
## The "github_pages_foldering" task
### Overview
In your project's Gruntfile, add a section named `github_pages_foldering` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
github_pages_foldering: {
default: {
// Your settings is here.
},
},
});
```
### Settings
#### urls
Type: `String|Array`
Your Github Pages URLs are here.
#### index
Type: `String`
Your Single Page Application HTML file path is here.
#### cwd
Type: `String`
Your root path is here, Not required (cwd = Change Working Directory).
### Example Usage
```js
grunt.initConfig({
github_pages_foldering: {
default: {
urls: [
'contact',
'about',
'blog',
'blog/grunt-is-really-good',
'blog/angular-is-so-sexy'
],
index: 'index.html',
cwd: 'build'
}
}
});
```
**Project structure (Before):**
```
└── app
├── js
│ ├── angular.js
│ └── main.js
└── views
├── common
└── homepage
...
..
.
├── Gruntfile.js
└── index.html
...
..
.
```
**Project structure (After):**
```
└── app
├── js
│ ├── angular.js
│ └── main.js
└── views
├── common
└── homepage
...
..
.
├── Gruntfile.js
└── index.html
...
..
.
└── build
├── contact
│ └── index.html
├── about
│ └── index.html
└── blog
├── index.html
├── grunt-is-really-good
│ └── index.html
└── angular-is-so-sexy
└── index.html
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## License
MIT License.
## Author
Copyright © 2014 Sercan Eraslan