Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cria arquivo de scripts separado #296

Merged
merged 5 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,10 @@ _site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
vendor

# mypy files
.mypy_cache/

# Ruby files
.ruby-lsp/
45 changes: 29 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,46 +47,56 @@ diciotech
├── _config.yml (arquivo de configuração do Jekyll)
├── _data (aqui devem ser adicionados os termos e definições)
│   ├── en-us
│   │   ├── a.yml
│   │   ├── a.yml (termos e definições que começam com a letra A)
│   │   ├── ...
│   │   └── z.yml
│   │   ├── numbers.yml (termos e definições que começam com números)
│   │   ├── ...
│   │   ├── strings.yml (onde ficam as traduções dos termos na página)
│   │   ├── symbols.yml (termos e definições que começam com símbolos)
│   │   ├── ...
│   │   └── z.yml (termos e definições que começam com a letra Z)
│   └── pt-br
│   ├── a.yml
│      ├── ...
│   └── z.yml
│   │   ├── a.yml (termos e definições que começam com a letra A)
│   │   ├── ...
│   │   ├── numbers.yml (termos e definições que começam com números)
│   │   ├── ...
│   │   ├── strings.yml (onde ficam as traduções dos termos na página)
│   │   ├── symbols.yml (termos e definições que começam com símbolos)
│   │   ├── ...
│   │   └── z.yml (termos e definições que começam com a letra Z)
├── Gemfile (arquivo de dependências do Ruby)
├── Gemfile.lock (arquivo de dependências do Ruby com as versões específicas)
├── _includes
│   └── script.liquid.js (aqui devem ficar códigos js que dependem de valores do Jekyll)
├── _json (cria os cards.json final a partir dos yml)
│   ├── en-us
│   │   └── cards.json
│   └── pt-br
│   └── cards.json
├── _layouts
│   └── base.liquid (layout base do site)
├── _pages (onde ficam as traduções dos termos na página)
├── _pages
│   ├── en-us
│   │   └── search.md
│   │   └── search.md (define que vai ter uma página search em inglês)
│   └── pt-br
│   └── search.md
│   └── search.md (define que vai ter uma página search em português)
├── _sass (onde devem ser feitas as mudanças no estilo do site)
│   ├── base.scss
│   ├── cookies.scss
│   ├── dark_theme.scss
│   ├── light_theme.scss
│   └── variables.scss
├── _scripts (aqui devem ficar códigos js que dependem de valores do Jekyll)
│   └── scripts.js.liquid
└── _site (onde o Jekyll gera o site final, não deve ser versionado)
└── ...
```

Dentre os arquivos e pastas, os mais importantes são:

- `_data/`: onde ficam os arquivos YAML com os termos e definições, separados por idioma e letra. Aqui é onde você deve adicionar novos termos;
- `_includes/`: onde ficam códigos js que dependem de valores do Jekyll. Você pode adicionar códigos novos no arquivo `script.liquid.js`, ou criar novos arquivos. Lembre-se de incluir os arquivos novos no layout base;
- `_layouts/base.liquid`: layout base da página, basicamente um html com variáveis em liquid definidas em `_pages/`;
- `_pages/`: onde ficam as traduções de textos na página que não são termos e suas definições;
- `_data/`: onde ficam os arquivos YAML com os termos e definições do dicionário, separados por idioma e letra (com exceção do arquivo `strings.yml` explicado abaixo). Aqui é onde você deve adicionar novos termos;
- `_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.

## Como funciona o build do site
Expand Down Expand Up @@ -128,12 +138,15 @@ _site/
│   ├── cookies.js
│   ├── levenshtein.js
│   ├── pwa.js
│   ├── scripts.js
│   └── theme.js
├── diciotech.webmanifest
├── en-us
│   ├── assets
│   │   └── data
│   │   └── cards.json
│   │   ├── data
│   │   | └── cards.json
| | └── js
| | └── scripts.js
│   ├── diciotech.webmanifest
│   └── index.html
└── index.html
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ url: "https://diciotech.netlify.app/" # the base hostname & protocol for your si
# -----------------------------------------------------------------------------

# Jekyll Polyglot
languages: ["en-us", "pt-br"]
languages: ["pt-br", "en-us"]
default_lang: "pt-br"
exclude_from_localization: ["assets"]
lang_from_path: true
Expand Down Expand Up @@ -36,7 +36,7 @@ exclude:
- run_on_data_changed.sh
- todo.md

include: ["_json", "_pages"]
include: ["_json", "_pages", "_scripts"]

plugins:
- jekyll-minifier
Expand Down
18 changes: 18 additions & 0 deletions _data/en-us/strings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
accept_cookies: Accept and close
all: All
change_theme: Change theme
cookies_message: Diciotech uses cookies to ensure you get a better experience. Disabling site cookies may impair the functionality of some features and by continuing to use, you agree to our Cookie Policy.
currently_with: Currently with
favorites: Favorites
filter_by_category: "Filter by category:"
no_results:
alt: Woman looking at site with no data
text: |
<p> The searched term was not found! Check if it was typed correctly.</p>
<p>If it is correct, please create an issue in the <a href="https://github.com/levxyca/diciotech/issues">repository</a> so that this term can be added to Diciotech.</p>
<p>We appreciate your collaboration! 😄</p>
read_more: Read more
search_placeholder: Search...
site_description: A tech dictionary for people who want to learn more about technical terms within technology!
terms: terms!
view_on_github: View project on GitHub
18 changes: 18 additions & 0 deletions _data/pt-br/strings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
accept_cookies: Concordar e fechar
all: Todos
change_theme: Mudar tema
cookies_message: O Diciotech usa cookies para garantir que você obtenha uma melhor experiência. Desativar os cookies do site pode prejudicar a funcionalidade de alguns recursos e ao continuar usando, você concorda com a nossa Política de Cookies.
currently_with: Atualmente com
favorites: Favoritos
filter_by_category: "Filtrar por categoria:"
no_results:
alt: Mulher olhando para site sem dados
text: |
<p> O termo pesquisado não foi encontrado! Verifique se foi digitado corretamente.</p>
<p>Caso esteja correto, por favor crie uma issue no <a href="https://github.com/levxyca/diciotech/issues">repositório</a> para que esse termo possa ser adicionado ao Diciotech.</p>
<p>Agradecemos sua colaboração! 😄</p>
read_more: Ler mais
search_placeholder: Pesquisar...
site_description: Um dicionário tech para pessoas que querem aprender mais sobre termos técnicos dentro da tecnologia!
terms: termos!
view_on_github: Visualizar projeto no GitHub
Loading
Loading