docs estilos e padronizacao de docs (#1)

* docs estilos e padronizacao de docs

* Update mkdocs.yml

README.md

@@ -1,2 +1,21 @@
-# 2024.2-Avatar
-Repositório para o projeto de um jogo RPG baseado na série animada Avatar
+<h1 align="center"> Avatar </h1>
+<h3 align="center"> 2024.2 </h3>
+
+## 💡 Sobre
+
+Repositório para o projeto de um jogo RPG baseado na série animada Avatar, desenvolvido na disciplina de Sistemas de Banco de Dados 1 na Universidade de Brasilia.
+
+## 📒 Documentação
+
+A documentação do projeto está disponivel nesse [link](https://sbd1.github.io/2024.2-Avatar/).
+
+
+## ⚙️ Instruções para colaboradores
+
+**Para desenvolver a documentação:**
+
+1. Instale o python e o pip
+2. Instale o mkdocs-material com ```pip install mkdocs-material```
+3. Execute a documentação localmente com ```python -m mkdocs serve```
+4. **Obs:** As suas alterações só ficaram disponíveis na versão online após o PR para o branch *docs* ser aceito
+5. **Importante:** Nunca mexa no branch *gh-pages*

docs/Apresentacoes/Modulo01.md

@@ -0,0 +1,4 @@
+# Modulo 01
+
+## Apresentação
+

docs/DD/v1.md

@@ -0,0 +1,25 @@
+# Dicionário de Dados
+
+## Introdução
+
+
+
+## Desenvolvimento
+
+
+
+## Histórico de versão
+
+| Data  | Versão | Descrição     | Autor |
+| :---: | :----: | ------------- | ----- |
+| DD/MM |  1.0   | XXXXXXXXXXXXX | XXXXX |
+
+<!-- 
+Padrão Usuarios GitHub Histórico de Versões --- Não Apagar
+
+[João Schmitz](https://github.com/JoaoSchmitz)
+[Júlia Takaki](https://github.com/juliatakaki)
+[Luciano Freitas](https://github.com/luciano-freitas-melo)
+[Luciano Ricardo](https://github.com/l-ricardo)
+[Willian Silva](https://github.com/Wooo589)
+ -->

docs/DER/v1.md

@@ -0,0 +1,25 @@
+# Diagrama Entidade Relacionamento
+
+## Introdução
+
+
+
+## Desenvolvimento
+
+
+
+## Histórico de versão
+
+| Data  | Versão | Descrição     | Autor |
+| :---: | :----: | ------------- | ----- |
+| DD/MM |  1.0   | XXXXXXXXXXXXX | XXXXX |
+
+<!-- 
+Padrão Usuarios GitHub Histórico de Versões --- Não Apagar
+
+[João Schmitz](https://github.com/JoaoSchmitz)
+[Júlia Takaki](https://github.com/juliatakaki)
+[Luciano Freitas](https://github.com/luciano-freitas-melo)
+[Luciano Ricardo](https://github.com/l-ricardo)
+[Willian Silva](https://github.com/Wooo589)
+ -->

docs/MR/v1.md

@@ -0,0 +1,25 @@
+# Modelo Relacional
+
+## Introdução
+
+
+
+## Desenvolvimento
+
+
+
+## Histórico de versão
+
+| Data  | Versão | Descrição     | Autor |
+| :---: | :----: | ------------- | ----- |
+| DD/MM |  1.0   | XXXXXXXXXXXXX | XXXXX |
+
+<!-- 
+Padrão Usuarios GitHub Histórico de Versões --- Não Apagar
+
+[João Schmitz](https://github.com/JoaoSchmitz)
+[Júlia Takaki](https://github.com/juliatakaki)
+[Luciano Freitas](https://github.com/luciano-freitas-melo)
+[Luciano Ricardo](https://github.com/l-ricardo)
+[Willian Silva](https://github.com/Wooo589)
+ -->

docs/index.md

@@ -1,17 +1,35 @@
-# Welcome to MkDocs
+<h1 align="center"> Avatar </h1>
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+### Jogo
 
-## Commands
+Jogo RPG baseado na série animada Avatar.
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
 
-## Project layout
+### Autores
+
+<table style="border: none; text-align: center; vertical-align: middle;">
+    <tr style="border: none; text-align: center; vertical-align: middle;">
+        <td style="border: none; text-align: center; vertical-align: middle;">
+            <a href="url"><img src="https://avatars.githubusercontent.com/JoaoSchmitz" height="auto" width="200" style="border-radius:50%"></a><br/>
+            <a href="https://github.com/JoaoSchmitz"><strong>João Schmitz</strong></a>
+        </td>
+        <td style="border: none; text-align: center; vertical-align: middle;">
+            <a href="url"><img src="https://avatars.githubusercontent.com/juliatakaki" height="auto" width="200" style="border-radius:50%"></a><br/>
+            <a href="https://github.com/juliatakaki"><strong>Júlia Takaki</strong></a>
+        </td>
+        <td style="border: none; text-align: center; vertical-align: middle;">
+            <a href="url"><img src="https://avatars.githubusercontent.com/luciano-freitas-melo" height="auto" width="200" style="border-radius:50%"></a><br/>
+            <a href="https://github.com/luciano-freitas-melo"><strong>Luciano Freitas</strong></a>
+        </td>
+        <td style="border: none; text-align: center; vertical-align: middle;">
+            <a href="url"><img src="https://avatars.githubusercontent.com/l-ricardo" height="auto" width="200" style="border-radius:50%"></a><br/>
+            <a href="https://github.com/l-ricardo"><strong>Luciano Ricardo</strong></a>
+        </td>
+        <td style="border: none; text-align: center; vertical-align: middle;">
+            <a href="url"><img src="https://avatars.githubusercontent.com/Wooo589" height="auto" width="200" style="border-radius:50%"></a><br/>
+            <a href="https://github.com/Wooo589"><strong>Willian Silva</strong></a>
+        </td>
+    </tr>
+</table>
+
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -1,5 +1,74 @@
+# Project information
 site_name: 2024.2-Avatar
 site_url: https://2024.2-avatar.com
-theme:
+site_author: O Grupo
+site_description: >-
+  Repositório para o projeto de um jogo RPG baseado na série animada Avatar, desenvolvido na disciplina de Sistemas de Banco de Dados 1 na Universidade de Brasilia.
+
+
+# Repository
+repo_url: https://github.com/SBD1/2024.2-Avatar
+repo_name: 2024.2-Avatar
+
+
+# Configuration
+docs_dir: docs
+theme: 
   name: material
-
+  language: pt-BR
+  icon:
+    repo: fontawesome/brands/github
+  font: 
+    text: Roboto
+  favicon: assets/icon.svg
+  logo: assets/icon.svg
+  features:
+    - navigation.instant
+    - navigation.section
+    - navigation.path
+    - navigation.top
+    - tabs
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Mudar para o modo escuro
+      primary: deep blue
+      accent: blue 
+    - scheme: slate 
+      toggle:
+        icon: material/brightness-4
+        name: Mudar para o modo claro
+      primary: deep blue
+      accent: blue
+
+
+# Page tree
+nav: 
+  - Início: index.md
+  - Diagrama Entidade Relacionamento:
+    - Versão 01: DER/v1.md
+  - Dicionário de Dados:
+    - Versão 01: DD/v1.md
+  - Modelo Relacional:
+    - Versão 01: MR/v1.md
+  - Apresentações:
+    - Modulo 01: Apresentacoes/Modulo01.md
+
+
+# Extensions
+markdown_extensions:
+  - pymdownx.emoji
+  - pymdownx.tasklist
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences