https://github.com/fga-eps-mds/2020.2-violeta-documentacao

https://github.com/fga-eps-mds/2020.2-violeta-documentacao

documento mkdocs pasta

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/fga-eps-mds/2020.2-violeta-documentacao
• Owner: fga-eps-mds
• Created: 2021-02-09T17:51:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-26T01:27:37.000Z (over 3 years ago)
• Last Synced: 2024-04-12T14:18:57.677Z (10 months ago)
• Topics: documento, mkdocs, pasta
• Homepage: https://fga-eps-mds.github.io/2020.2-Violeta-Documentacao/
• Size: 25.3 MB
• Stars: 2
• Watchers: 9
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# EPS-2020-2-G5

## Para utilizar framework de documentação

## Requisitos

1. mkdocs

2. mkdocs-material

obs: Instalar pelo pip versão do python 3.7 ou +;

## Rodar local   

Para rodar local bastar ir na pasta do projeto e e escrever: `mkdocs serve`

todos arquivos que você modificar estarão atualizados em tempo real no seu

servidor local.

## Documentar

Lembre sempre que para documentar não basta apenas colocar o documento .md na

pasta docs tem que lembrar de colocar o link para esse documento no mkdocs.yml

para mais informações visite [mkdocs page](https://www.mkdocs.org/)