pages boilerplate

pages-passe-partout

C'est toujours un plaisir d'étayer vos superbes sites statiques.

Commencer

 # 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

$ yarn < task > [options]

par exemple

 # Runs the app in development mode
$ yarn serve --port 5210 --open
# Builds the app for production to the `dist` folder
$ yarn build --production

Scripts disponibles

yarn lint ou npm run lint

Lint les fichiers de styles et de scripts.

yarn compile ou npm run compile

Compilez le fichier styles, scripts et pages.

yarn serve ou npm run serve

Exécute l'application en mode développement avec un serveur automatisé.

choix

• open : Ouvrir le navigateur au démarrage, Par défaut : false
• port : Spécifiez le port du serveur, par défaut : 2080

yarn build ou npm run build

Construit l'application pour la production dans le dossier dist . Il minimise la source en mode production pour les meilleures performances.

choix

• production : indicateur de mode de production, par défaut : false
• prod : Alias ​​de production

yarn start ou npm run start

Exécution de projets en mode production.

choix

• open : Ouvrir le navigateur au démarrage, Par défaut : false
• port : Spécifiez le port du serveur, par défaut : 2080

yarn deploy ou npm run deploy

Déployez le dossier dist sur les pages GitHub.

choix

• branch : Le nom de la branche vers laquelle vous allez pousser, par défaut : 'gh-pages'

yarn clean ou npm run clean

Nettoyez les fichiers dist et temp .

Structure des dossiers

 └── 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

En rapport

• zce/x-pages - Un workflow gulp entièrement géré pour les sites de pages statiques.

Contribuer

1. Forkez- le sur GitHub !
2. Clonez le fork sur votre propre machine.
3. Vérifiez votre branche de fonctionnalités : git checkout -b my-awesome-feature
4. Validez vos modifications dans votre propre branche : git commit -am 'Add some feature'
5. Remettez votre travail à votre fourchette : git push -u origin my-awesome-feature
6. Soumettez une Pull Request afin que nous puissions examiner vos modifications.

REMARQUE : assurez-vous de fusionner les dernières versions de "en amont" avant de faire une pull request !

Licence

MIT © 汪磊