[![Build Status][travis-image]][travis-url]
Always a pleasure scaffolding your awesome static sites.
# clone repo
$ git clone https://github.com/denghuiquan/denghuiquan.github.io.git my-awesome-pages
$ cd my-awesome-pages
# install dependencies
$ yarn # or npm install$ yarn <task> [options]# Runs the app in development mode
$ yarn serve --port 5210 --open
# Builds the app for production to the `dist` folder
$ yarn build --productionLint the styles & scripts files.
Compile the styles & scripts & pages file.
Runs the app in development mode with a automated server.
open: Open browser on start, Default:falseport: Specify server port, Default:2080
Builds the app for production to the dist folder. It minify source in production mode for the best performance.
production: Production mode flag, Default:falseprod: Alias toproduction
Running projects in production mode.
open: Open browser on start, Default:falseport: Specify server port, Default:2080
Deploy the dist folder to GitHub Pages.
branch: The name of the branch you'll be pushing to, Default:'gh-pages'
Clean the dist & temp files.
NOTE: If you need to run script with options, you can add them for yarn command like this
yarn start --port 8080 --open true; and you can add for npm command likenpm run start -- --port 8080 --open true
└── my-awesome-pages ·································· project root
├── public ········································· static folder
│ └── favicon.ico ································ static file (unprocessed)
├── src ············································ source folder
│ ├── assets ····································· assets folder
│ │ ├── fonts ·································· fonts folder
│ │ │ ├── pages.eot ·························· font file (imagemin)
│ │ │ ├── pages.svg
│ │ │ ├── pages.ttf
│ │ │ └── pages.woff
│ │ ├── images ································· images folder
│ │ │ ├── brands.svg ························· image file (imagemin)
│ │ │ └── logo.png
│ │ ├── scripts ································ scripts folder
│ │ │ └── main.js ···························· script file (babel / uglify)
│ │ └── styles ································· styles folder
│ │ ├── _icons.scss
│ │ ├── _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
│ │ ├── footer.html
│ │ └── header.html ···························· partial file (dont output)
│ ├── about.html ································· page file (use layout & partials)
│ └── index.html ································· page file (use layout & partials)
├── .editorconfig ·································· editor config file
├── .gitignore ····································· git ignore file
├── .npmrc
├── .travis.yml ···································· travis ci config file
├── LICENSE ········································ repo license
├── README.md ······································ repo readme
├── gulpfile.js ···································· gulp tasks file
├── package-lock.json
├── package.json ··································· package file
└── yarn.lock ······································ yarn lock file
- Fork it on GitHub!
- Clone the fork to your own machine.
- Checkout your feature branch:
git checkout -b my-awesome-feature - Commit your changes to your own branch:
git commit -am 'Add some feature' - Push your work back up to your fork:
git push -u origin my-awesome-feature - 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!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent