Bloques de Código Markdown
Los bloques de código son esenciales para documentación técnica, tutoriales y cualquier contenido que incluya ejemplos de código. Markdown proporciona varias formas de formatear código, desde código en línea simple hasta bloques de código completos con resaltado de sintaxis.
Código en Línea
Para fragmentos cortos de código dentro de oraciones, usa comillas invertidas simples:
Usa el comando `git status` para verificar tu repositorio.
La función `console.log()` imprime en la consola.
Presiona `Ctrl+C` para detener el proceso.
Resultado:
Usa el comandogit status
para verificar tu repositorio.
La función console.log()
imprime en la consola.
Presiona Ctrl+C
para detener el proceso.
Bloques de Código Delimitados
Para código de múltiples líneas, usa comillas invertidas triples:
```
function greet(name) {
console.log("Hello, " + name + "!");
}
greet("World");
```
Resultado:
function greet(name) {
console.log("Hello, " + name + "!");
}
greet("World");
Resaltado de Sintaxis
Agrega el nombre del lenguaje después de las comillas invertidas de apertura para resaltado de sintaxis:
JavaScript
```javascript
function calculateSum(a, b) {
return a + b;
}
const result = calculateSum(5, 3);
console.log(result); // Salida: 8
```
Python
```python
def calculate_sum(a, b):
return a + b
result = calculate_sum(5, 3)
print(result) # Salida: 8
```
Identificadores de Lenguajes Populares
Lenguaje | Identificador | Alternativo |
---|---|---|
JavaScript | javascript | js |
Python | python | py |
Java | java | |
C++ | cpp | c++ |
C# | csharp | cs |
HTML | html | |
CSS | css | |
SQL | sql | |
JSON | json | |
XML | xml | |
Shell | bash | sh |
TypeScript | typescript | ts |
React JSX | jsx | |
PHP | php | |
Go | go | |
Rust | rust | |
Swift | swift |
Notas Importantes
Los bloques de código delimitados son el método preferido para formatear código en Markdown ya que proporcionan mejor resaltado de sintaxis y son más ampliamente soportados en diferentes plataformas.
Mejores Prácticas
1. Siempre Usar Resaltado de Sintaxis
❌ Sin resaltado de sintaxis:
```
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```
✅ Con resaltado de sintaxis:
```javascript
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```
2. Mantener los Ejemplos de Código Enfocados
❌ Demasiado código irrelevante:
```javascript
// Mucho código de configuración...
const express = require('express');
const app = express();
const PORT = 3000;
// ... más configuración ...
// El ejemplo real (enterrado en la configuración)
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
// ... más código estándar ...
```
✅ Enfocado en la parte importante:
```javascript
// Crear un endpoint de API simple
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
```
Casos de Uso Comunes
Documentación de API
Solicitud:
POST /api/users
Content-Type: application/json
{
"name": "John Doe",
"email": "[email protected]"
}
Respuesta:
{
"id": 123,
"name": "John Doe",
"email": "[email protected]",
"created_at": "2024-01-15T10:30:00Z"
}
Archivos de Configuración
Crea un archivo.env
en la raíz de tu proyecto:
# Configuración de base de datos
DB_HOST=localhost
DB_PORT=5432
DB_NAME=miapp
DB_USER=postgres
DB_PASSWORD=contraseña123
# Claves de API
API_KEY=tu_clave_api_aqui
SECRET_KEY=tu_clave_secreta_aqui
Solución de Problemas
Problemas Comunes
- Código que no se formatea: Verifica las comillas invertidas apropiadas
- Resaltado de sintaxis que no funciona: Verifica el identificador de lenguaje
- Código que rompe el diseño: Usa saltos de línea apropiados
Escapar Comillas Invertidas
Si necesitas mostrar comillas invertidas en tu código:Ejemplo de comilla invertida simple:
- •Escribir: `código`
- •Resultado:
código
- •Escribir: ```bloque de código```
- •Resultado:
bloque de código
- •Escribir: ``comilla invertida``
- •Resultado:
comilla invertida
Finalmente, aprendamos sobre saltos de línea para perfeccionar tu formato de texto.