Markdown Guía de bloques de código: código en línea, bloques cercados y resaltado de sintaxis

El formato de código es una de las características más fuertes de Markdown. Ya sea que estés documentando una función, mostrando un comando de terminal, o escribiendo un tutorial, la sintaxis de código de Markdown mantiene el código visualmente distinto. correctamente formateado y (en la mayoría de las plataformas) resaltado por sintaxis. Esta guía abarca todo lo relacionado con Bloques de código Markdown.

Código en línea

Envuelva un fragmento corto o una sola expresión en un solo backtick:

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

El código en línea representa una fuente monospacial, visualmente distinta del texto circundante. Utilizarlo para:

• Nombres de las funciones y métodos: addEventListener()
• Nombres de las variables: isLoading
• Nombres de archivos: package.json
• Argumentos de la orden: --verbose
• Expresiones de código cortas

Si su código en línea contiene un backtick, utilice backticks dobles para envolverlo:

`` `backtick inside` ``

Bloques de código cercados

En el caso de un código de varias líneas, utilizar los backticks triples (`) para abrir y cerrar el bloque:

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

El resbalón, el espacio y las nuevas líneas se conservan exactamente.

Resaltando la sintaxis

Añadir un identificador de idioma después de la apertura de las marcas de retroceso triples para habilitar el resaltado de la sintaxis:

```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 lenguaje común

Bloques de código con resonancia

Una sintaxis Markdown más antigua usa un resguardo de 4 espacios para bloques de código:

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

Esto es CommonMark-compatible pero menos legible y no admite identificadores de lenguaje. En su lugar, utilice bloques cercados (triple backticks).

Convertir código desde documentos Word

El texto monospacio en Word (Courier New, Consolas, etc.) se convierte en código en línea cuando se usa WordToMD. Multi-line code in Word converts depending on how it was formatted:

• párrafo de fuente monospacio → Puede convertirse en varios fragmentos de código en línea
• Word Estilo del código → Convierte a un bloque de código
• Bloque de texto literal → Puede necesitar cercas manuales

Después de la conversión, compruebe las secciones de código y añada la valla adecuada si es necesario:

1. Encuentra el código que debería ser un bloque
2. Envuélvelo con tres palos de espalda .
3. Añadir el identificador de idioma apropiado

Ejemplos específicos del idioma

Solicitudes de 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"
}
```

Los comandos de los terminales

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

Producción de diferencias

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

Configuración de YAML

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

Bloques de código anidados (para la documentación)

Al documentar Markdown mismo, use 4 backticks para envolver un bloque que contiene 3 backticks:

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

Apoyo a las plataformas

Números de línea

El estándar Markdown no admite números de línea en bloques de código. Algunas plataformas y generadores de sitios estáticos agregan esto a través de plugins:

• Prism.js (utilizado por muchos SSG) añadir {numberLines: true} en la valla de código
• GitHub no hay números de línea nativos en Markdown renderizado (use GitHub vista de culpa en su lugar)
• GitBook Números de línea a través de la configuración de bloques de código

Copiar el código de los bloques

GitHub y muchas plataformas agregan un botón Copy a los bloques de código automáticamente. Esto es una mejora de renderizado no requiere nada especial en su Markdown.

FAQ

¿Por qué no está resaltada la sintaxis de mi bloque de código? O el identificador del idioma falta o está mal escrito, o la plataforma no admite el idioma específico. Compruebe la lista de identificadores de arriba.

¿Cómo muestro los backticks dentro de un bloque de código? Dentro de un bloque de código cercado, los backticks se tratan como caracteres literales. Sólo la cerca de tres espaldas requiere un manejo especial.

Mi documento de Word tenía un código colorido resaltado con sintaxis. ¿Podrá WordToMD conservar los colores? No Markdown los bloques de código no conservan el formato en color. WordToMD convierte el texto en un bloque de código; el resaltado de sintaxis se aplica entonces por el renderizado Markdown basado en el identificador de lenguaje.

¿Puedo resaltar líneas específicas dentro de un bloque de código? El estándar Markdown no soporta esto. Algunas plataformas (como Astro con Shiki, o Hugo) apoyan la línea destacando a través de comentarios: {1,3-5} después del identificador del idioma.

Guías relacionadas

• Markdown Sintaxis guía rápida Referencia completa
• Word a API Documentación Documentación que requiere mucho código
• Se trata de una serie de medidas que se aplican a todos los Estados miembros, incluidos los Estados miembros de la Unión Europea. GitHub-formato de código específico

Conclusión

Los bloques de código de descenso son sencillos: backticks para código en línea, backticks triples con un identificador de idioma para los bloques. Después de convertir un documento Word con WordToMD, comprobar que el texto monospacio se haya envuelto correctamente en la sintaxis del código, y agregar identificadores de lenguaje para el resaltado de la sintaxis adecuada en su plataforma de destino.