O editor Advanced WYSIWYG suporta duas formas de exibir código em seus artigos: código inline e blocos de código.
- O código inline formata um breve trecho ou comando dentro de uma linha de texto, distinguindo-o visualmente da prosa ao redor.
- O bloco de código exibe um bloco de código com múltiplas linhas como uma seção separada com ressaltamento de sintaxe, um rótulo de linguagem e uma opção de cópia.
O Document360 usa Prism.js para realce de sintaxe e suporta uma ampla variedade de linguagens de programação em blocos de código.
Cenários recomendados
- Use código inline para referenciar um nome de variável, caminho de arquivo, comando ou parâmetro dentro de uma frase — por exemplo, "Defina o valor de
max_retriespara 3" - Use um bloco de código para scripts multi-linha, exemplos de solicitações de API, arquivos de configuração ou qualquer leitor de código que possa precisar copiar e executar
- Use um rótulo de linguagem personalizado ao documentar uma linguagem de script proprietária ou formato de configuração que não está disponível na lista padrão
- Use blocos de código dentro dos elementos de aba para mostrar a mesma chamada de API em vários idiomas lado a lado — por exemplo, Python, JavaScript e cURL em abas separadas
Código Inline
O código inline é aplicado diretamente ao texto selecionado dentro de um parágrafo, sem criar um novo bloco.
- Selecione o texto que você quer formatar como código inline.
- Na barra de ferramentas flutuante, clique no ícone de código Inline ou use o atalho
Ctrl + Ede teclado .
O texto selecionado aparece estilizado como código dentro da frase.
Bloco de Código
Um bloco de código cria uma seção dedicada para exibir código multilinha com realce sintádico.
.png)
Para inserir um bloco de código, use qualquer um dos seguintes métodos:
- Clique no ícone do bloco de código no menu Inserção rápida (aparece quando um bloco está vazio)
- Tipo três backticks
```e pressãoEnter - Use o comando
/code blockde corte e pressioneEnter
Após inserir um bloco de código:
- Clique no bloco de código — um menu flutuante aparece.
- Selecione o idioma desejado no menu suspenso para realçar a sintaxe.
- Digite seu código dentro do bloco.
Para copiar o bloco, clique no ícone Copiar . Para removê-lo, clique no ícone Excluir .
Definindo um rótulo de linguagem personalizado: Se o idioma que você precisa não estiver na lista, selecione Personalizado no menu suspenso, clique no ícone Editar , insira o título desejado e clique em Atualizar.
No editor avançado WYSIWYG, um bloco de código sempre requer um título. Para ocultar o título no site da base de conhecimento, aplique CSS personalizado via Configurações > site da base de conhecimento > CSS e JavaScript personalizados. Isso vai ocultar o cabeçalho em todos os blocos de código do site. Se você prefere blocos de código sem título, use o editor Markdown.
Linguagens suportadas
O Document360 suporta realce de sintaxe para as seguintes linguagens (entre outras):
HTML, C#, Java, JavaScript, XML, JSON, CSS, SQL, Python, Markdown, PHP, PowerShell, Ruby e Texto.
Para uma lista completa, consulte as línguas suportadas pelo Prism.
Melhores práticas
- Use código inline para referências curtas (uma linha ou menos) e blocos de código para qualquer coisa mais longa
- Sempre selecione o idioma correto para seu bloco de código — o realce da sintaxe precisa melhora a legibilidade e sinaliza o idioma correto para os leitores
- Adicione um título descritivo ao seu bloco de código para que os leitores saibam o que o código faz antes de ler
- Mantenha blocos de código focados — um bloco por trecho distinto ou exemplo; Evite combinar código não relacionado em um único bloco
- Mantenha o código limpo e livre de comentários provisórios que podem causar erros se executados diretamente