Skip to content

Commit 6041ab7

Browse files
committed
improve docs
1 parent b129387 commit 6041ab7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,19 @@ Encontrou algum bug? Abra uma issue [aqui](https://github.com/backend-br/backend
2323
## Executando localmente
2424

2525
Depois de clonar o repositório, execute `npm i && npm run dev`, isso vai instalar tudo que é necessário e carregar o site no seu `localhost`.
26+
27+
## Arquivos
28+
29+
O site é construído usando o [Hexo](https://hexo.io). Tudo está dentro da pasta `themes/backendbrasil`, lá você encontra os arquivos do tema.
30+
31+
- `themes/backendbrasil/assets` contém os arquivos estáticos(JS, SCSS, Imagens, ícones, etc)
32+
- `styles` contém todos os arquivos SCSS
33+
- `img` contém todas as imagens, que são minificadas automaticamente
34+
- `icons` contém alguns ícones, mas também temos o [font-awesome](https://fontawesome.com/)
35+
- `main.scss` é o único arquivo renderizado, nele contém todas as importações do SCSS
36+
- `themes/backendbrasil/helper` contém funções aplicadas no `handlebars`
37+
- também temos o [handlebars-helpers](https://github.com/helpers/handlebars-helpers)
38+
- `themes/backendbrasil/languages` contém os arquivos de traduções
39+
- `themes/backendbrasil/layout` contém todos os arquivos relacionados ao layout da página
40+
- `themes/backendbrasil/layout/` contém templates de páginas na raiz
41+
- `themes/backendbrasil/layout/partials` contém partes reutilizáveis

0 commit comments

Comments
 (0)