pages boilerplate

padrão de páginas

É sempre um prazer estruturar seus incríveis sites estáticos.

Começando

 # clone repo
$ git clone https://github.com/zce/pages-boilerplate.git my-awesome-pages
$ cd my-awesome-pages
# install dependencies
$ yarn # or npm install 

Uso

$ yarn < task > [options]

por exemplo

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

Scripts Disponíveis

yarn lint ou npm run lint

Lint os arquivos de estilos e scripts.

yarn compile ou npm run compile

Compile o arquivo de estilos, scripts e páginas.

yarn serve ou npm run serve

Executa o aplicativo em modo de desenvolvimento com um servidor automatizado.

opções

• open : abre o navegador ao iniciar, padrão: false
• port : Especifique a porta do servidor, Padrão: 2080

yarn build ou npm run build

Cria o aplicativo para produção na pasta dist . Ele reduz a fonte no modo de produção para obter o melhor desempenho.

opções

• production : sinalizador do modo de produção, padrão: false
• prod : Alias ​​para production

yarn start ou npm run start

Executando projetos em modo de produção.

opções

• open : abre o navegador ao iniciar, padrão: false
• port : Especifique a porta do servidor, Padrão: 2080

yarn deploy ou npm run deploy

Implante a pasta dist nas páginas do GitHub.

opções

• branch : O nome do branch para o qual você fará push, Padrão: 'gh-pages'

yarn clean ou npm run clean

Limpe os arquivos dist e temp .

Estrutura de pastas

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

Relacionado

• zce/x-pages - Um fluxo de trabalho gulp totalmente gerenciado para sites de páginas estáticas.

Contribuindo

1. Faça um fork no GitHub!
2. Clone o garfo em sua própria máquina.
3. Confira seu branch de recursos: git checkout -b my-awesome-feature
4. Envie suas alterações para seu próprio branch: git commit -am 'Add some feature'
5. Empurre seu trabalho de volta para o fork: git push -u origin my-awesome-feature
6. Envie uma solicitação pull para que possamos revisar suas alterações.

NOTA : Certifique-se de mesclar o mais recente do "upstream" antes de fazer uma solicitação pull!

Licença

MIT ©汪磊