https://github.com/school-digital-agenda/SDADocs

Documentações da School Digital Agenda
https://github.com/school-digital-agenda/SDADocs

mkdocs

Last synced: 3 months ago
JSON representation

Documentações da School Digital Agenda

• Host: GitHub
• URL: https://github.com/school-digital-agenda/SDADocs
• Owner: school-digital-agenda
• Created: 2022-06-16T20:19:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-10T20:59:45.000Z (over 2 years ago)
• Last Synced: 2023-03-04T02:25:03.925Z (almost 2 years ago)
• Topics: mkdocs
• Size: 1.09 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SDAArchRef

Projeto para documentação da arquitetura de referência da aplicação **School Digital Agenda**

## Tecnologias

Tecnologia      | Versão | Referência

----------------|--------|----------------------------------------------

Python          | 3.8^   | 

MkDocs          | 1.3.0  | https://www.mkdocs.org/

MkDocs Material | 8.3.6  | https://squidfunk.github.io/mkdocs-material/

----------------------------------

## Desenvolvimento

### Configurar ambiente

``` bash

# Instalar MkDocs

pip install mkdocs

# Instalar MkDocs Material

pip install mkdocs-material

# Install Git Revision Date

pip install mkdocs-git-revision-date-plugin

```

### Configurar IDE

Caso utilize o VS Code, adicione o `yaml.schema` a seu `settings.json`:

``` yaml

{

  "yaml.schemas": {

    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"

  }

}

```

### Desenvolvimento

``` bash

# Executar aplicação localmente

mkdocs serve

# Gerando site

mkdocs build

```