Pular para conteúdo

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

  1. Abra a página no site e clique no ícone Editar esta página, no canto superior direito do conteúdo.
  2. O GitHub abre o arquivo .md daquela página. Faça a alteração.
  3. Clique em Commit changes…, escreva uma frase curta sobre o que mudou (ex.: Atualiza data do procedimento de standards) e confirme.
  4. 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

  1. No repositório, entre na pasta da seção, por exemplo docs/parametrizacao/.
  2. Clique em Add file → Create new file e dê um nome em minúsculas, sem acentos e com hífens: nome-da-pagina.md.
  3. Cole o modelo de página e preencha.
  4. Abra o arquivo mkdocs.yml na raiz e adicione a página no bloco nav, na posição em que ela deve aparecer no menu:

    - Parametrização:
        - parametrizacao/index.md
        - 1. Tecnologia, arquivos e pastas: parametrizacao/tecnologia-arquivos-pastas.md
        - Nova página: parametrizacao/nome-da-pagina.md
    

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

  1. Envie a imagem para docs/assets/images/ (Add file → Upload files). Use nomes sem espaços: tela-simulador-abate.png.
  2. Na página, use o caminho relativo a partir da pasta da página:

    ![Descrição do que a imagem mostra](../assets/images/tela-simulador-abate.png)
    

Adicionar arquivos para download (.d, .txt)

  1. Envie o arquivo para docs/arquivos/.
  2. 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:

    [:material-download: Baixar i3pc-novo.d](../arquivos/i3pc-novo.d){ .md-button download }
    
    ??? abstract "Conteúdo integral de `i3pc-novo.d`"
    
        ```text
        --8<-- "arquivos/i3pc-novo.d"
        ```
    

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.

!!! warning "Título do aviso"
    Texto do aviso, com 4 espaços no início da linha.

Use abl para código Progress. hl_lines destaca linhas que precisam ser ajustadas (datas, empresas):

for each paabate where
         paabate.pab-data >= 04/12/2024:
    delete paabate.
end.
```abl hl_lines="2"
for each paabate where
         paabate.pab-data >= 04/12/2024:
    delete paabate.
end.
```
Clique para abrir

Conteúdo que fica escondido até a pessoa clicar.

??? note "Clique para abrir"
    Conteúdo que fica escondido até a pessoa clicar.

Troque ??? por ???+ para o bloco começar aberto.

Pacote Área
I3PC-ABATE Abate
| Pacote | Área |
|---|---|
| `I3PC-ABATE` | Abate |
  • Servidor de homologação
  • Parâmetro -s conferido
- [x] Servidor de homologação
- [ ] Parâmetro `-s` conferido

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