Skip to content

Latest commit

 

History

History
126 lines (79 loc) · 3.95 KB

README-pt.md

File metadata and controls

126 lines (79 loc) · 3.95 KB
Raw

Read in English

Como perder peso (no browser)

O guia definitivo de performance para o desenvolvedor front-end.

image

Contribuindo

Para adicionar novas dicas ou editar dicas existentes, basta se dirigir a pasta src/documents. Lá você irá encontrar todas elas em formato Markdown (.md). Lembre-se também de adicionar as referências de cada dica na wiki References.

Instruções

Como faço para rodar o projeto localmente?

  1. Instale o Git e o NodeJS, caso você não os tenha ainda.

  2. Abra o terminal e baixe o DocPad através do comando:

sudo npm install -fg docpad
  1. Agora clone o projeto:
git clone git@github.com:<your-github-username>/browser-diet.git
  1. Depois vá para pasta do projeto:
cd browser-diet
  1. Instale as dependências:
docpad install
  1. E finalmente rode:
docpad run

Agora você irá ver o site rodando em localhost:9778 :D

Como faço para rodar a versão em outra língua?

Basta entrar no arquivo docpad.coffee e alterar o valor da variável currentLang.

Depois é só rodar novamente: docpad run.

Estrutura

O projeto é feito utilizando o DocPad, um static generator em NodeJS, e a estrutura se dá na seguinte forma:

.
|-- out/
|-- src/
|   |-- documents
|   |-- layouts
|   |-- partials
`-- package.json

out/

É onde os arquivos gerados são armazenados, uma vez que o DocPad tenha sido rodado. Porém, esse diretório se torna desnecessário no versionamento, por isso está ignorado (.gitignore).

src/documents

Contém todas as dicas em formato Markdown (.md), além das imagens, fontes, arquivos CSS e JS.

src/layouts

Contém o template padrão da aplicação.

src/partials

Contém blocos de código reaproveitáveis.

package.json

Lista as dependências de módulos do NodeJS.

Time

Design

Autores

Revisores

Créditos

Fontes

Ilustrações

Licença

O código encontra-se sob licença MIT e todo conteúdo sob licença Creative Commons BY-SA 3.0