pages boilerplate

страницы-шаблон

Всегда приятно создавать ваши потрясающие статические сайты.

Начиная

 # clone repo
$ git clone https://github.com/zce/pages-boilerplate.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 --production

Доступные сценарии

yarn lint или npm run lint

Проанализируйте файлы стилей и скриптов.

yarn compile или npm run compile

Скомпилируйте файл стилей, сценариев и страниц.

yarn serve или npm run serve

Запускает приложение в режиме разработки с автоматизированным сервером.

параметры

• open : открывать браузер при запуске. По умолчанию: false
• port : укажите порт сервера, по умолчанию: 2080

yarn build или npm run build

Собирает приложение для производства в папке dist . Он минимизирует исходный код в производственном режиме для достижения наилучшей производительности.

параметры

• production : Флаг производственного режима. По умолчанию: false
• prod : псевдоним для production

yarn start или npm run start

Запуск проектов в производственном режиме.

параметры

• open : открывать браузер при запуске. По умолчанию: false
• port : укажите порт сервера, по умолчанию: 2080

yarn deploy или npm run deploy

Разверните папку dist на GitHub Pages.

параметры

• branch : имя ветки, в которую вы будете нажимать. По умолчанию: 'gh-pages'

yarn clean или npm run clean

Очистите файлы dist и temp .

Структура папок

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

Связанный

• zce/x-pages — полностью управляемый рабочий процесс gulp для сайтов со статическими страницами.

Содействие

1. Форкните его на GitHub!
2. Клонируйте вилку на свою машину.
3. Проверьте свою ветку функций: git checkout -b my-awesome-feature
4. Зафиксируйте изменения в своей ветке: git commit -am 'Add some feature'
5. Верните свою работу обратно на вилку: git push -u origin my-awesome-feature
6. Отправьте запрос на включение , чтобы мы могли просмотреть ваши изменения.

ПРИМЕЧАНИЕ . Прежде чем делать запрос на включение, обязательно объедините последнюю версию из «восходящего потока»!

Лицензия

MIT © 汪磊