Como editar esta base¶
Tudo é editado pelo navegador, no GitHub. Não é preciso instalar nada. Cada alteração salva (commit) publica o site de novo automaticamente em cerca de 2 minutos.
O site é público
Qualquer pessoa com o link pode ler o conteúdo. Não inclua nomes ou dados de clientes, senhas, endereços de servidores ou capturas de tela sem antes ocultar essas informações.
Editar uma página existente¶
- Abra a página no site e clique no ícone Editar esta página, no canto superior direito do conteúdo.
- O GitHub abre o arquivo
.mddaquela página. Faça a alteração. - Clique em Commit changes…, escreva uma frase curta sobre o que mudou (ex.: Atualiza data do procedimento de standards) e confirme.
- Acompanhe a publicação na aba Actions do repositório. Quando ficar verde, a alteração já está no site.
Use a visualização antes de salvar
No editor do GitHub, a aba Preview mostra uma prévia do texto. Os avisos coloridos e as abas só aparecem formatados no site publicado.
Criar uma página nova¶
- No repositório, entre na pasta da seção, por exemplo
docs/parametrizacao/. - Clique em Add file → Create new file e dê um nome em minúsculas, sem acentos e com hífens:
nome-da-pagina.md. - Cole o modelo de página e preencha.
-
Abra o arquivo
mkdocs.ymlna raiz e adicione a página no bloconav, na posição em que ela deve aparecer no menu:
Indentação no mkdocs.yml
O mkdocs.yml depende dos espaços no início da linha. Copie a linha de cima e mude só o texto, mantendo o mesmo recuo.
Para criar uma seção nova no menu superior, crie uma pasta em docs/ com um index.md dentro e adicione o bloco no nav, no mesmo formato das seções existentes.
Adicionar imagens¶
- Envie a imagem para
docs/assets/images/(Add file → Upload files). Use nomes sem espaços:tela-simulador-abate.png. -
Na página, use o caminho relativo a partir da pasta da página:
Adicionar arquivos para download (.d, .txt)¶
- Envie o arquivo para
docs/arquivos/. -
Na página, crie o botão de download e, se quiser, mostre o conteúdo completo. O conteúdo é lido direto do arquivo, então só existe uma cópia para manter:
Componentes que você pode usar¶
Use as cores sempre com o mesmo significado:
Objetivo
info (azul): contexto, objetivo da etapa.
Dica
tip (verde): atalhos e boas práticas.
Atenção
warning (amarelo): algo que precisa ser conferido ou ajustado antes.
Crítico
danger (vermelho): comandos que apagam ou alteram dados.
Use abl para código Progress. hl_lines destaca linhas que precisam ser ajustadas (datas, empresas):
Clique para abrir
Conteúdo que fica escondido até a pessoa clicar.
Troque ??? por ???+ para o bloco começar aberto.
Modelo de página¶
---
title: Título da página
description: Uma frase sobre o que a página cobre (aparece na pesquisa).
---
# Título da página
!!! info "Objetivo"
Para que serve esta etapa.
## Primeiro assunto
Explicação em texto corrido.
```abl
/* código Progress */
```
## Segundo assunto
- Item
- Item
Estrutura de pastas¶
base-conhecimento-i3pc/
├── mkdocs.yml ← menu e configurações do site
├── docs/
│ ├── index.md ← página inicial
│ ├── contribuir.md ← esta página
│ ├── primeiros-passos/
│ ├── menus/
│ ├── parametrizacao/
│ ├── arquivos/ ← .d e .txt para download
│ └── assets/
│ ├── images/ ← imagens e capturas de tela
│ ├── stylesheets/agrosys.css← visual (cores, fontes)
│ └── javascripts/ ← árvore do menu
└── .github/workflows/publicar.yml ← publicação automática