Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zce/pages-boilerplate
Always a pleasure scaffolding your awesome static sites.
https://github.com/zce/pages-boilerplate
boilerplate pages static-site
Last synced: 10 days ago
JSON representation
Always a pleasure scaffolding your awesome static sites.
- Host: GitHub
- URL: https://github.com/zce/pages-boilerplate
- Owner: zce
- License: mit
- Created: 2017-07-21T03:11:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-29T12:15:31.000Z (about 1 year ago)
- Last Synced: 2024-11-17T22:54:04.087Z (2 months ago)
- Topics: boilerplate, pages, static-site
- Language: HTML
- Homepage: https://zce.me/pages-boilerplate/
- Size: 714 KB
- Stars: 9
- Watchers: 4
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pages-boilerplate
[![Build Status][travis-image]][travis-url]
[![Package Version][version-image]][version-url]
[![License][license-image]][license-url]
[![Dependency Status][dependency-image]][dependency-url]
[![devDependency Status][devdependency-image]][devdependency-url]
[![Code Style][style-image]][style-url]
> Always a pleasure scaffolding your awesome static sites.
## Getting Started
```shell
# clone repo
$ git clone https://github.com/zce/pages-boilerplate.git my-awesome-pages
$ cd my-awesome-pages
# install dependencies
$ yarn # or npm install
```
## Usage
```shell
$ yarn [options]
```
### e.g.
```shell
# Runs the app in development mode
$ yarn serve --port 5210 --open
# Builds the app for production to the `dist` folder
$ yarn build --production
```
### Available Scripts
#### `yarn lint` or `npm run lint`
Lint the styles & scripts files.
#### `yarn compile` or `npm run compile`
Compile the styles & scripts & pages file.
#### `yarn serve` or `npm run serve`
Runs the app in development mode with a automated server.
##### options
- `open`: Open browser on start, Default: `false`
- `port`: Specify server port, Default: `2080`
#### `yarn build` or `npm run build`
Builds the app for production to the `dist` folder. It minify source in production mode for the best performance.
##### options
- `production`: Production mode flag, Default: `false`
- `prod`: Alias to `production`
#### `yarn start` or `npm run start`
Running projects in production mode.
##### options
- `open`: Open browser on start, Default: `false`
- `port`: Specify server port, Default: `2080`
#### `yarn deploy` or `npm run deploy`
Deploy the `dist` folder to [GitHub Pages](https://pages.github.com).
##### options
- `branch`: The name of the branch you'll be pushing to, Default: `'gh-pages'`
#### `yarn clean` or `npm run clean`
Clean the `dist` & `temp` files.
## Folder Structure
```
└── my-awesome-pages ································· project root
├─ public ········································· static folder
│ └─ favicon.ico ································· static file (unprocessed)
├─ src ············································ source folder
│ ├─ assets ······································ assets folder
│ │ ├─ fonts ···································· fonts folder
│ │ │ └─ pages.ttf ····························· font file (imagemin)
│ │ ├─ images ··································· images folder
│ │ │ └─ logo.png ······························ image file (imagemin)
│ │ ├─ scripts ·································· scripts folder
│ │ │ └─ main.js ······························· script file (babel / uglify)
│ │ └─ styles ··································· styles folder
│ │ ├─ _variables.scss ······················· partial sass file (dont output)
│ │ └─ main.scss ····························· entry scss file (scss / postcss)
│ ├─ layouts ····································· layouts folder
│ │ └─ basic.html ······························· layout file (dont output)
│ ├─ partials ···································· partials folder
│ │ └─ header.html ······························ partial file (dont output)
│ ├─ about.html ·································· page file (use layout & partials)
│ └─ index.html ·································· page file (use layout & partials)
├─ .csscomb.json ·································· csscomb config file
├─ .editorconfig ·································· editor config file
├─ .gitignore ····································· git ignore file
├─ .travis.yml ···································· travis ci config file
├─ CHANGELOG.md ··································· repo changelog
├─ LICENSE ········································ repo license
├─ README.md ······································ repo readme
├─ gulpfile.js ···································· gulp tasks file
├─ package.json ··································· package file
└─ yarn.lock ······································ yarn lock file
```
## Related
- [zce/x-pages](https://github.com/zce/x-pages) - A fully managed gulp workflow for static page sites.
## Contributing
1. **Fork** it on GitHub!
2. **Clone** the fork to your own machine.
3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
6. Submit a **Pull Request** so that we can review your changes.
> **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!
## License
[MIT](LICENSE) © [汪磊](https://zce.me)
[travis-image]: https://img.shields.io/travis/zce/pages-boilerplate/master.svg
[travis-url]: https://travis-ci.org/zce/pages-boilerplate
[version-image]: https://img.shields.io/github/package-json/v/zce/pages-boilerplate/master.svg
[version-url]: https://github.com/zce/pages-boilerplate
[license-image]: https://img.shields.io/github/license/zce/pages-boilerplate.svg
[license-url]: https://github.com/zce/pages-boilerplate/blob/master/LICENSE
[dependency-image]: https://img.shields.io/david/zce/pages-boilerplate.svg
[dependency-url]: https://david-dm.org/zce/pages-boilerplate
[devdependency-image]: https://img.shields.io/david/dev/zce/pages-boilerplate.svg
[devdependency-url]: https://david-dm.org/zce/pages-boilerplate?type=dev
[style-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-url]: http://standardjs.com