From d6a1519f17f3c5f04e62e5faf517fbbc0a06cbf2 Mon Sep 17 00:00:00 2001 From: lricardo Date: Thu, 24 Oct 2024 17:43:59 -0300 Subject: [PATCH] docs estilos e padronizacao de docs (#1) * docs estilos e padronizacao de docs * Update mkdocs.yml --- README.md | 23 ++++++++++- docs/Apresentacoes/Modulo01.md | 4 ++ docs/DD/v1.md | 25 ++++++++++++ docs/DER/v1.md | 25 ++++++++++++ docs/MR/v1.md | 25 ++++++++++++ docs/index.md | 42 +++++++++++++------ mkdocs.yml | 73 +++++++++++++++++++++++++++++++++- 7 files changed, 201 insertions(+), 16 deletions(-) create mode 100644 docs/Apresentacoes/Modulo01.md create mode 100644 docs/DD/v1.md create mode 100644 docs/DER/v1.md create mode 100644 docs/MR/v1.md diff --git a/README.md b/README.md index 37d31fa..2e29952 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# 2024.2-Avatar -Repositório para o projeto de um jogo RPG baseado na série animada Avatar +

Avatar

+

2024.2

+ +## 💡 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* diff --git a/docs/Apresentacoes/Modulo01.md b/docs/Apresentacoes/Modulo01.md new file mode 100644 index 0000000..4b149fc --- /dev/null +++ b/docs/Apresentacoes/Modulo01.md @@ -0,0 +1,4 @@ +# Modulo 01 + +## Apresentação + diff --git a/docs/DD/v1.md b/docs/DD/v1.md new file mode 100644 index 0000000..9db3c26 --- /dev/null +++ b/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 | + + \ No newline at end of file diff --git a/docs/DER/v1.md b/docs/DER/v1.md new file mode 100644 index 0000000..6be6009 --- /dev/null +++ b/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 | + + \ No newline at end of file diff --git a/docs/MR/v1.md b/docs/MR/v1.md new file mode 100644 index 0000000..56d6b5c --- /dev/null +++ b/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 | + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 000ea34..33ae2e8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,35 @@ -# Welcome to MkDocs +

Avatar

-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 + + + + + + + + + +
+
+ João Schmitz +
+
+ Júlia Takaki +
+
+ Luciano Freitas +
+
+ Luciano Ricardo +
+
+ Willian Silva +
+ - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml index 77d9c6f..60b2d07 100644 --- a/mkdocs.yml +++ b/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