Markdown Guia de blocos de código: código em linha, blocos cercados e destaque de sintaxe

A formatação de código é uma das características mais fortes do Markdown. Se você está documentando uma função, mostrando um comando terminal, ou escrevendo um tutorial, a sintaxe de código Markdown mantém o código visualmente distinto, adequadamente formatado, e (na maioria das plataformas) destacado pela sintaxe. Este guia abrange tudo sobre Blocos de código Markdown.

Código em linha

Envolver um pequeno trecho ou uma única expressão em um único backtick:

Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.

Código em linha renderiza em uma fonte monospacial, visualmente distinta do texto circundante. Use-o para:

• Nome da função e do método: addEventListener()
• Nomes de variáveis: isLoading
• Nome do ficheiro: package.json
• Argumentos de comando: --verbose
• Expressões de código curto

Se o seu código em linha contém um backtick, use backticks duplos para envolvê-lo:

`` `backtick inside` ``

Blocos de código cercados

Para código de várias linhas, utilizar backticks triples (`) para abrir e fechar o bloco:

```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```

As incisões, espaçamento e novas linhas são preservadas exatamente.

Sintase de destaque

Adicionar um identificador de linguagem após a abertura de três backticks para habilitar a salientação da sintaxe:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))
```

```javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
```

```bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```

Identificadores de Língua Comum

Blocos de código com indeto

Uma sintaxe mais antiga Markdown usa 4-espaço indentation para blocos de código:

    function oldStyle() {
        return "This is a code block";
    }

É compatível com CommonMark, mas menos legível e não suporta identificadores de linguagem. Em vez disso, use blocos cercados (três backticks).

Converter código de Word documentos

Monospace texto em Word (Courier New, Consolas, etc.) converte para código em linha quando você usa WordToMD. Multi-line code in Word converts depending on how it was formatted:

• Parágrafo de fonte monospaço → Pode tornar-se em fragmentos de código em linha múltiplos
• Word Estilo de código → Converte para um bloco de código
• Bloco de texto literal → Pode precisar de cercas manuais

Após a conversão, verifique as secções de código e adicione a cerca adequada, se necessário:

1. Encontre o código que deve ser um bloco
2. Envolve-o com triplo backticks
3. Adicionar o identificador de idioma apropriado

Exemplos específicos de língua

Solicitações HTTP

```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN

{
  "name": "Alice",
  "email": "alice@example.com"
}
```

Comandos de terminal

```bash
npm install
npm run build
npm run dev
```

Output de diferença

```diff
- const oldValue = "hello";
+ const newValue = "world";
  console.log(newValue);
```

Configuração YAML

```yaml
server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgresql://localhost:5432/mydb
```

Blocos de código aninhados (para documentação)

Ao documentar o Markdown em si, use 4 backticks para envolver um bloco que contém 3 backticks:

````markdown
```python
# This is a code block inside documentation
```
````

Apoio à plataforma

Números de linha

O padrão Markdown não suporta números de linha em blocos de código. Algumas plataformas e geradores de sites estáticos adicionam isso por meio de plugins:

• Prism.js (utilizado por muitos SSG) adicionar {numberLines: true} na cerca de código
• GitHub nenhum número de linha nativo em Markdown renderizado (use GitHub Visualização de culpa em vez disso)
• GitBook números de linha através de configurações de bloco de código

Código de cópia de blocos

GitHub e muitas plataformas adicionam um botão Copy aos blocos de código automaticamente. Este é um aprimoramento de renderização não requer nada especial em seu Markdown.

FAQ

Porque é que a minha sintaxe de bloco de código não está destacada? Ou o identificador da língua está faltando ou está mal escrito, ou a plataforma não suporta a língua específica. Verifique a lista de identificadores acima.

Como é que eu mostro os backticks dentro de um bloco de código? Dentro de um bloco de código cercado, os backticks são tratados como caracteres literais. Apenas a cerca de três retaguardas precisa de um tratamento especial.

Meu documento Word tinha código colorido com sintaxe destacada. Será que WordToMD preservará as cores? Nenhum bloco de código Markdown não preserva a formatação de cores. WordToMD converte o texto num bloco de código; A salientação da sintaxe é então aplicada pelo renderização Markdown com base no identificador da linguagem.

Posso destacar linhas específicas dentro de um bloco de código? O padrão Markdown não suporta isso. Algumas plataformas (como Astro com Shiki, ou Hugo) apoiam a linha destacando através de comentários: {1,3-5} Após o identificador da língua.

Guia Relacionado

• Markdown Síntase guia rápido Referência completa
• Word a API Documentação Documentação pesada em códigos
• Word para GitHub Markdown GitHub - formatação de código específica

Conclusão

Os blocos de código de marcação são simples: backticks para código em linha, backticks triplos com um identificador de idioma para blocos. Depois de converter um documento Word com WordToMD, verificar se o texto em monospaço foi corretamente envolto na sintaxe do código, e adicionar identificadores de linguagem para o realce de sintaxe adequado na sua plataforma de destino.