Skip to content

Commit f7544ed

Browse files
authored
Merge pull request #54 from Calindra/EIRUNE-2052-melhorar-tema-da-documentacao-do-eitri
Eirune 2052 melhorar tema da documentacao do eitri
2 parents d6c88fd + ce562b1 commit f7544ed

26 files changed

Lines changed: 584 additions & 328 deletions

.github/workflows/en_deploy2s3.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,10 @@ jobs:
2424
path: .cache
2525
restore-keys: |
2626
mkdocs-material-
27-
- run: pip install mkdocs-material
28-
- run: pip install mkdocs-exclude-search
29-
- run: pip install mkdocs-glightbox
30-
- run: pip install mkdocs-awesome-pages-plugin
31-
- run: pip install mkdocs-with-pdf
32-
- run: pip install mkdocs-redirects
33-
- run: bash -c 'cd en && mkdocs build'
27+
- name: Install dependencies
28+
run: pip install -r requirements.txt
29+
- name: Build site
30+
run: cd en && mkdocs build
3431

3532
- name: Configure AWS Credentials
3633
uses: aws-actions/configure-aws-credentials@v1

.github/workflows/pt_deploy2s3.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,10 @@ jobs:
2424
path: .cache
2525
restore-keys: |
2626
mkdocs-material-
27-
- run: pip install mkdocs-material
28-
- run: pip install mkdocs-exclude-search
29-
- run: pip install mkdocs-glightbox
30-
- run: pip install mkdocs-awesome-pages-plugin
31-
- run: pip install mkdocs-with-pdf
32-
- run: pip install mkdocs-redirects
33-
- run: bash -c 'cd pt && mkdocs build'
27+
- name: Install dependencies
28+
run: pip install -r requirements.txt
29+
- name: Build site
30+
run: cd pt && mkdocs build
3431

3532
- name: Configure AWS Credentials
3633
uses: aws-actions/configure-aws-credentials@v1

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# eitri-docs
22

3-
Os projetos em inglês e em português são 2 projetos completamente separados e a única coisa que compartilham são os assets da pasta `override`.
3+
Os projetos em inglês e em português são 2 projetos completamente separados e a única coisa que compartilham são os assets da pasta `override`.
44

55
Para rodar o projeto você precisará:
66

@@ -13,10 +13,10 @@ Para rodar o projeto você precisará:
1313
3. Ativar o virtual environment do Python (O caminho vai depender do seu SO e da versão do Python):
1414

1515
- No windows:
16-
`source venv/Scripts/activate`
16+
`source venv/Scripts/activate`
1717

1818
- No Linux:
19-
`source venv/bin/activate`
19+
`source venv/bin/activate`
2020

2121
> **OBS1**: isso fará com que este venv seja a instância do python usada para as instalações de dependências e não a instalação global do python, similar ao node_modules no JS
2222
@@ -26,9 +26,9 @@ Para rodar o projeto você precisará:
2626
2727
4. Instalar mkdocs e plugins
2828

29-
`pip install mkdocs-material mkdocs-exclude-search mkdocs-glightbox mkdocs-awesome-pages-plugin mkdocs-with-pdf mkdocs-redirects`
29+
`pip install -r requirements.txt`
3030

31-
5. Entrar na pasta "*pt*" ou "*en*" e rodar o projeto
31+
5. Entrar na pasta "_pt_" ou "_en_" e rodar o projeto
3232

3333
`mkdocs serve --livereload`
3434

@@ -46,11 +46,10 @@ Para rodar o projeto você precisará:
4646

4747
- Para informações adicionais sobre redirecionamentos no mkdocs acesse [este link](https://github.com/mkdocs/mkdocs-redirects)
4848

49-
5049
### Navegação
5150

5251
A construção dos menus para navegação é configurada a partir do plugin [awesome pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) para mkdocs.
5352

5453
Com ela você pode incluir um arquivo `.pages` dentro de uma pasta e este arquivo passa a reger a forma como o mkdocs irá gerar os menus para aquele nível de dados.
5554

56-
Para mais informações, consulte o [repositório do plugin awesome pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin).
55+
Para mais informações, consulte o [repositório do plugin awesome pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin).

en/docs/community-and-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Eitri has an exclusive channel for the developer community where you can get sup
1010

1111
To access our Discord server and interact with the Eitri community, just use the invite link:
1212

13-
[:octicons-arrow-right-24: Download Discord](https://discord.com/download){:target="_blank" .md-button .md-button--primary }
13+
[ Download Discord](https://discord.com/download){:target="_blank" .md-button .md-button--primary }
1414

15-
[:octicons-arrow-right-24: Eitri on Discord](https://discord.gg/qmJycBFM){:target="_blank" .md-button .md-button--primary }
15+
[ Eitri on Discord](https://discord.gg/qmJycBFM){:target="_blank" .md-button .md-button--primary }

en/docs/design-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Eitri Luminus is Eitri's basic components library for building Eitri-app screens
1212

1313
Eitri Luminus now includes [Tailwind 3](https://v3.tailwindcss.com/){:target="_blank"} and [DaisyUI 4](https://v4.daisyui.com/){:target="_blank"}
1414

15-
[:octicons-arrow-right-24: Eitri Luminus Documentation ( 2.x.x )](https://cdn.83io.com.br/library/luminus-ui/doc/latest/){:target="_blank" .md-button .md-button--primary }
15+
[ Eitri Luminus Documentation ( 2.x.x )](https://cdn.83io.com.br/library/luminus-ui/doc/latest/){:target="_blank" .md-button .md-button--primary }
1616

1717
> For documentation of previous versions [click here](https://cdn.83io.com.br/library/luminus-ui/doc/1.83.0/){:target="_blank"}
1818

en/docs/eitri-cli.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Many of the additional functions of Eitri are available as options for the main
3232

3333
### login
3434

35-
:fontawesome-solid-terminal:{ .lg .middle } `eitri login [options]`
35+
⌨️ `eitri login [options]`
3636

3737
Logs into the Eitri platform, creating account credentials on your machine and linking your command-line tool to your Eitri developer account.
3838

@@ -48,7 +48,7 @@ Logs into the Eitri platform, creating account credentials on your machine and l
4848

4949
### create
5050

51-
:fontawesome-solid-terminal:{ .lg .middle } `eitri create [options] <project-name>`
51+
⌨️ `eitri create [options] <project-name>`
5252

5353
Creates a new Eitri-App project on your machine and registers it on the Eitri platform.
5454

@@ -76,7 +76,7 @@ You will need to provide some information when creating an Eitri-App:
7676

7777
### start
7878

79-
:fontawesome-solid-terminal:{ .lg .middle } `eitri start [options]`
79+
⌨️ `eitri start [options]`
8080

8181
The `eitri start` command initializes the Eitri-App for development, generating a QR Code that should be scanned with the app of your organization in which Eitri was integrated.
8282

@@ -94,7 +94,7 @@ As you develop and save your files locally, your Eitri-App will have a hot-reloa
9494

9595
### push-version
9696

97-
:fontawesome-solid-terminal:{ .lg .middle } `eitri push-version [options]`
97+
⌨️ `eitri push-version [options]`
9898

9999
Uploads a version of your Eitri-App to the Console, enabling publication. When this command is executed, a version of your Eitri-App will be added to the console and will be available for publication in the registered environments for the application.
100100

@@ -112,7 +112,7 @@ Uploads a version of your Eitri-App to the Console, enabling publication. When t
112112

113113
### self-update
114114

115-
:fontawesome-solid-terminal:{ .lg .middle } `eitri self-update`
115+
⌨️ `eitri self-update`
116116

117117
Updates your version of the Eitri CLI by uninstalling previous versions and installing the latest stable version.
118118

@@ -122,7 +122,7 @@ It is recommended to always keep the latest version of the Eitri CLI to ensure t
122122

123123
### workspace
124124

125-
:fontawesome-solid-terminal:{ .lg .middle } `eitri workspace [options]`
125+
⌨️ `eitri workspace [options]`
126126

127127
Manages and allows the use of multiple workspaces.
128128

@@ -145,7 +145,7 @@ Manages and allows the use of multiple workspaces.
145145

146146
### clean
147147

148-
:fontawesome-solid-terminal:{ .lg .middle } `eitri clean [options]`
148+
⌨️ `eitri clean [options]`
149149

150150
Cleans your remote workspace.
151151

@@ -161,7 +161,7 @@ If there is an issue with your workspace, the `eitri clean` command can help ree
161161

162162
### libs
163163

164-
:fontawesome-solid-terminal:{ .lg .middle } `eitri libs [options]`
164+
⌨️ `eitri libs [options]`
165165

166166
Lists the versions of Eitri libraries.
167167

@@ -174,15 +174,15 @@ Lists the versions of Eitri libraries.
174174

175175
### doctor
176176

177-
:fontawesome-solid-terminal:{ .lg .middle } `eitri doctor`
177+
⌨️ `eitri doctor`
178178

179179
Checks the dependencies and settings of your machine to ensure everything is correct for Eitri-App development.
180180

181181
---
182182

183183
### publish
184184

185-
:fontawesome-solid-terminal:{ .lg .middle } `eitri publish -e [environment-id] [options]`
185+
⌨️ `eitri publish -e [environment-id] [options]`
186186

187187
Publishes the current version in the selected environment.
188188

@@ -198,7 +198,7 @@ Publishes the current version in the selected environment.
198198

199199
### test
200200

201-
:fontawesome-solid-terminal:{ .lg .middle } `eitri test [options]`
201+
⌨️ `eitri test [options]`
202202

203203
Runs the tests of your Eitri-App.
204204

@@ -210,7 +210,7 @@ Runs the tests of your Eitri-App.
210210

211211
### app
212212

213-
:fontawesome-solid-terminal:{ .lg .middle } `eitri app [options]`
213+
⌨️ `eitri app [options]`
214214

215215
Manages the execution of Eitri-Apps from the application declared in the app-config.yaml file.
216216

en/docs/eitri-play.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To download Eitri Play check out the options available:
1717

1818
<div class="grid" markdown>
1919

20-
[:fontawesome-brands-android: __Android__ on Play Store](https://play.google.com/store/apps/details?id=tech.eitri.play){:target="_blank" .md-button .md-button--primary }
21-
[:fontawesome-brands-apple: __iOS__ on App Store](https://testflight.apple.com/join/8ZVxnxXr){:target="_blank" .md-button .md-button--primary }
20+
[🤖 __Android__ on Play Store](https://play.google.com/store/apps/details?id=tech.eitri.play){:target="_blank" .md-button .md-button--primary }
21+
[🍎 __iOS__ on App Store](https://testflight.apple.com/join/8ZVxnxXr){:target="_blank" .md-button .md-button--primary }
2222

2323
</div>

en/docs/eitri-shopping/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
title: Eitri Shopping
12
nav:
2-
- index.md
33
- exposed-apis.md
44
- recaptcha.md
55
- deeplinks.md

en/docs/eitri-shopping/deeplinks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ You will need to configure your website to have 2 files hosted in specific paths
334334

335335
With most e-commerce providers you can create/update those files by opening a ticket asking for it.
336336

337-
### [:simple-android: App Link (Android)](https://developer.android.com/training/app-links){:target="_blank"}
337+
### [🤖 App Link (Android)](https://developer.android.com/training/app-links){:target="_blank"}
338338
**File path:** `https://www.mywebsite.com/.well-known/assetlinks.json`
339339

340340
**File example:**
@@ -360,7 +360,7 @@ With most e-commerce providers you can create/update those files by opening a ti
360360
> Example: F8:57:A0:0C:AB:8B:B2:59:92:F7:3D:1D:38:6C:05:17:A8:3F:B1:19:B5:E7:05:5F:ED:B5:B8:27:EA:0C:E3:57
361361
362362

363-
### [:simple-apple: Universal Link (iOS)](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app)
363+
### [🍎 Universal Link (iOS)](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app)
364364

365365
**File path:** `https://www.mywebsite.com/.well-known/apple-app-site-association`
366366

en/docs/quick-guides/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
title: Quick Guides
12
nav:
2-
- index.md
33
- create-eitri-app.md
44
- ci-cd.md
55
- functional.md

0 commit comments

Comments
 (0)