Bloques de código

Usa bloques de código para mostrar comandos, archivos de configuración y fragmentos con resaltado de sintaxis.

Resaltado de sintaxis básico

const greeting = "Hello, Jamdesk!";
console.log(greeting);

Agregar un nombre de archivo

Muestra la ruta del archivo con el atributo title:

export const config = {
  name: "My Docs",
  theme: "jam"
};

Resaltado de líneas

Llama la atención sobre líneas específicas con la sintaxis {1,3-5}:

// This line is highlighted
const config = {
  apiKey: process.env.API_KEY,
  baseUrl: 'https://api.example.com', // highlighted
  timeout: 5000,                       // highlighted
  retries: 3,                          // highlighted
};

Números de línea

Agrega números de línea con showLineNumbers:

def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n - 1) + fibonacci(n - 2)

Línea de inicio personalizada

Comienza la numeración desde una línea específica:

func processRequest(ctx context.Context) error {
    // This is line 42
    return nil
}

Funciones combinadas

Usa varias funciones juntas:

import axios from 'axios';

const client = axios.create({
  baseURL: process.env.API_URL,
  timeout: 10000,
});

export default client;

Ocultar el botón de copiar

Agrega nocopy para quitar el botón de copiar de un bloque específico:

$ jamdesk build
Building 128 pages...
Done in 4.2s

Úsalo siempre que copiar el bloque le dé al lector algo que no funciona: una transcripción de terminal que mezcla comandos y resultados, un ejemplo censurado o un fragmento «esto no se debe hacer».

nocopy se combina con todas las demás opciones:

const config = loadConfig();
config.apiKey = "sk-live-REDACTED";

Grupos de código

Muestra el mismo código en varios lenguajes:

curl -X POST https://api.example.com/posts \
  -H "Authorization: Bearer $API_KEY"

Temas disponibles

Configura los temas de resaltado de sintaxis en docs.json:

{
  "styling": {
    "codeblocks": {
      "theme": {
        "light": "github-light",
        "dark": "github-dark"
      }
    }
  }
}

Tema de variables CSS

Para tener control total sobre los colores del resaltado de sintaxis, usa el tema de variables CSS:

{
  "styling": {
    "codeblocks": {
      "theme": "css-variables"
    }
  }
}

Luego personaliza los colores en tu style.css:

:root {
  --jd-token-keyword: #ff7b72;
  --jd-token-string: #a5d6ff;
  --jd-token-comment: #8b949e;
  --jd-token-function: #d2a8ff;
  --jd-token-constant: #79c0ff;
  --jd-token-parameter: #ffa657;
}

¿Qué sigue?