Skip to content

Commit

Permalink
Updated CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: George Araújo <[email protected]>
  • Loading branch information
george-gca committed Feb 4, 2025
1 parent 76b8ef5 commit 84f988e
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ diciotech
│   ├── img
│   │   └── ...
│   └── js
│   ├── cookies.js
│   ├── levenshtein.js
│   ├── pwa.js
│   └── theme.js
│   └── ...
├── _config.yml (arquivo de configuração do Jekyll)
├── _data (aqui devem ser adicionados os termos e definições)
│   ├── en-us
Expand Down Expand Up @@ -85,7 +82,7 @@ diciotech
│   ├── light_theme.scss
│   └── variables.scss
├── _scripts (aqui devem ficar códigos js que dependem de valores do Jekyll)
│   └── scripts.js.liquid
│   └── localized_scripts.js.liquid
└── _site (onde o Jekyll gera o site final, não deve ser versionado)
└── ...
```
Expand All @@ -96,8 +93,8 @@ Dentre os arquivos e pastas, os mais importantes são:
- `_data/LANG/strings.yml`: onde ficam as traduções dos termos na página que não são termos do dicionário;
- `_layouts/base.liquid`: layout base da página, basicamente um html com variáveis em liquid definidas em `_data/LANG/strings.yml`;
- `_sass/`: onde ficam os arquivos de estilo do site. Aqui é onde você deve fazer mudanças de css;
- `_scripts/`: onde ficam códigos js que dependem de valores do Jekyll. Você pode adicionar códigos novos no arquivo `scripts.js.liquid`, ou criar novos arquivos. Lembre-se de incluir os arquivos novos no layout base;
- `assets/`: onde ficam os arquivos de css, js e imagens que são copiados tal qual para o site final.
- `_scripts/`: onde ficam códigos js que dependem de valores do Jekyll. Você pode adicionar códigos novos no arquivo `localized_scripts.js.liquid`, ou criar novos arquivos. Lembre-se de incluir os arquivos novos no layout base;
- `assets/`: onde ficam os arquivos que são copiados tal qual para o site final.

## Como funciona o build do site

Expand Down Expand Up @@ -134,18 +131,19 @@ _site/
│   ├── img
│   │   └── ...
│   └── js
│   ├── cards.js
│   ├── cookies.js
│   ├── levenshtein.js
│   ├── localized_scripts.js
│   ├── pwa.js
│   ├── scripts.js
│   └── theme.js
├── diciotech.webmanifest
├── en-us
│   ├── assets
│   │   ├── data
│   │   | └── cards.json
| | └── js
| | └── scripts.js
| | └── localized_scripts.js
│   ├── diciotech.webmanifest
│   └── index.html
└── index.html
Expand Down

0 comments on commit 84f988e

Please sign in to comment.