Shortcodes personalizados

Shortcodes de diagramas

Diagramas de Mermaid

Mermaid es una herramienta de diagramación y gráficos que usa texto y código para generar diagramas. Admite diagramas de flujo, diagramas de secuencia, gráficos de Gantt y más.

Para incluir un diagrama Mermaid en tu publicación, sigue estos dos pasos:

1. Establece mermaid = true en la sección [extra] del front matter de tu página, sección o config.toml. Esto cargará el JavaScript necesario para renderizar los diagramas.

2. Usa el shortcode mermaid() para definir tu diagrama. Por ejemplo:

{% mermaid() %}
classDiagram
    class DistorsionesCognitivas {
        +PensamientoTodoONada()
        +Sobregeneralizacion()
        +FiltroMental()
        +SacarConclusionesPrecipitadas()
    }
    class PensamientoTodoONada {
        +VerEnExtremos()
    }
    class Sobregeneralizacion {
        +GeneralizarDeUnicoEjemplo()
    }
    class FiltroMental {
        +EnfocarseEnNegativo()
    }
    class SacarConclusionesPrecipitadas {
        +HacerSuposiciones()
    }
    DistorsionesCognitivas *-- PensamientoTodoONada
    DistorsionesCognitivas *-- Sobregeneralizacion
    DistorsionesCognitivas *-- FiltroMental
    DistorsionesCognitivas *-- SacarConclusionesPrecipitadas
{% end %}

El diagrama se renderizará así:

    classDiagram
    class DistorsionesCognitivas {
        +PensamientoTodoONada()
        +Sobregeneralizacion()
        +FiltroMental()
        +SacarConclusionesPrecipitadas()
    }
    class PensamientoTodoONada {
        +VerEnExtremos()
    }
    class Sobregeneralizacion {
        +GeneralizarDeUnicoEjemplo()
    }
    class FiltroMental {
        +EnfocarseEnNegativo()
    }
    class SacarConclusionesPrecipitadas {
        +HacerSuposiciones()
    }
    DistorsionesCognitivas *-- PensamientoTodoONada
    DistorsionesCognitivas *-- Sobregeneralizacion
    DistorsionesCognitivas *-- FiltroMental
    DistorsionesCognitivas *-- SacarConclusionesPrecipitadas

El shortcode de Mermaid admite dos parámetros:

• invertible: Si se establece en true (por defecto), el diagrama se invertirá en modo oscuro, igual que las imágenes invertibles.
• full_width: Permite que el diagrama ocupe el ancho del encabezado. Mira imagen a ancho completo.

Uso

{% mermaid(invertible=true, full_width=false) %}

Tu diagrama Mermaid va aquí. Puedes omitir los parámetros para usar los valores predeterminados.

{% end %}

Shortcodes de imagen

Todos los shortcodes de imagen admiten rutas absolutas, rutas relativas, y fuentes remotas en el parámetro src.

Todos los shortcodes de imagen tienen tres parámetros opcionales:

• inline. Valor predeterminado: false. Si se establece true, la imagen se mostrará en línea con el texto.
• full_width. Valor predeterminado: false (ver más abajo).
• lazy_loading. Valor predeterminado: true.

Imágenes de doble tema

Útil si deseas usar una imagen diferente para los temas claro y oscuro:

Uso

{{ dual_theme_image(light_src="img/paris_day.webp", dark_src="img/paris_night.webp" alt="La Torre Eiffel") }}

Imagen invertible

Ideal para gráficos, dibujos lineales, diagramas… Invierte los colores de la imagen. La imagen de origen se utilizará para el tema claro.

Uso

{{ invertible_image(src="img/graph.webp", alt="Gráfico invertible") }}

Imagen atenuable

Las imágenes con demasiado brillo o contraste pueden ser demasiado discordantes en un fondo oscuro. Aquí tienes un ejemplo de una fotografía que se atenúa cuando el tema oscuro está activo.

Uso

{{ dimmable_image(src="img/desert_by_oskerwyld.webp", alt="Fotografía de un desierto, cielo celestial") }}

Cambio de imagen al pasar el cursor

La imagen mostrada cambia cuando el usuario pasa el cursor por encima. Útil para comparaciones de antes y después, por ejemplo.

Uso

{{ image_hover(default_src="img/before.webp", hovered_src="img/after.webp", default_alt="Imagen editada", hovered_alt="Toma original") }}

Cambio de imagen vía click

Muestra una imagen y cambia a una diferente al hacer clic. Ideal para destacar diferencias o llamar la atención sobre detalles.

Uso

{{ image_toggler(default_src="img/mojave_day.webp", toggled_src="img/mojave_night.webp", default_alt="Mojave durante el día", toggled_alt="Mojave durante la noche") }}

Imagen a ancho completo

La imagen se expandirá para coincidir con el ancho del encabezado, que generalmente es más ancho que el texto del artículo (excepto en móvil/ventanas pequeñas).

Todos los otros shortcodes de imágenes pueden usar el ancho completo asignando el valor true al parámetro opcional full_width.

Uso

{{ full_width_image(src="img/amsterdam_by_oskerwyld.webp", alt="Fotografía de un canal en Ámsterdam") }}

Shortcodes de código

Mostrar ruta o URL

Muestra una ruta o URL en el siguiente bloque de código encontrado. Si comienza con “http”, se convertirá en un enlace. Particularmente útil cuando se usa junto con el shortcode de texto remot.

__pycache__/
*coverage*
.vscode/
dist/

Uso

{{ add_src_to_code_block(src="https://github.com/welpo/doteki/blob/main/.gitignore") }}

```.gitignore
__pycache__/
*coverage*
.vscode/
dist/
```

Shortcodes de texto

Texto remoto

Añade texto desde una URL remota o un archivo local.

El shortcode acepta tres parámetros:

• src: La URL de origen o ruta del archivo (obligatorio)
• start: Primera línea a mostrar (opcional, empieza en 1)
• end: Número de la última línea (opcional, por defecto es 0, la última línea)

Importante:

• Archivos remotos VS archivos locales: Si src empieza con “http”, se tratará como un archivo remoto. De lo contrario, se asume que es una ruta de archivo local.
• Acceso a archivos: Dado que utiliza la función load_data de Zola, los archivos locales deben estar dentro del directorio de Zola —ver la lógica de búsqueda de archivos. Desde tabi 2.16.0, el shortcode admite también rutas relativas.
• Formateo de bloques de código: Para mostrar el texto como un bloque de código, debes añadir manualmente las cercas de código Markdown (comillas invertidas) y, opcionalmente, especificar el lenguaje de programación para el resaltado sintáctico.

Uso

Añade un script de Python remoto dentro de un bloque de código con resaltado sintáctico:

```python
{{ remote_text(src="https://example.com/script.py") }}
```

Visualización de texto de un archivo local:

{{ remote_text(src="ruta/a/archivo.txt") }}

Mostar sólo las líneas 3 a 5 de un archivo remoto:

{{ remote_text(src="https://example.com/script.py", start=3, end=5) }}

Advertencias

Destaca información con estos shortcodes. Hay cinco tipos (type): note, tip, info, warning, y danger.

Puedes cambiar el title y el icon de la advertencia. Ambos parámetros aceptan texto y por defecto coinciden con el tipo de advertencia. icon puede ser cualquiera de los tipos de advertencia disponibles.

Uso

Puedes usar las advertencias de dos formas:

1. En línea con parámetros:

{{ admonition(type="danger", icon="tip", title="Un consejo importante", text="Mantente hidratado") }}

2. Con contenido en el cuerpo:

{% admonition(type="danger", icon="tip", title="Un consejo importante") %}
Mantente hidratado

Este método es especialmente útil para contenido largo o múltiples párrafos.
{% end %}

Ambos métodos admiten los mismos parámetros (type, icon, y title).

Citas multilenguaje

Este shortcode permite mostrar una cita traducida y en su lenguaje original:

Uso

{{ multilingual_quote(original="Ce qui est terrible, ce n’est pas de souffrir ni de mourir, mais de mourir en vain.", translated="Lo terrible no es sufrir o morir, sino morir en vano.", author="Jean-Paul Sartre") }}

Referencias con sangría francesa

Este shortcode formatea una sección de referencias con sangría francesa de la siguiente manera:

Uso

{% references() %}

Tus referencias van aquí.

Cada una en una línea nueva. Se renderizará Markdown (enlaces, cursivas…).

{% end %}

Spoilers

Este shortcode permite ocultar texto que se revelará al hacer clic. Por ejemplo: las galletas de la fortuna tiene su origen en Japón. Sí, en serio.

Como ves, el Markdown se renderiza.

Este shortcode tiene la opción fixed_blur para difuminar el texto “SPOILER”, en lugar de difuminar el contenido real. Por ejemplo: es innecesario esperar 24 horas antes de denunciar la desaparición de una persona.

Uso

{{ spoiler(text="texto que ocultar", fixed_blur=false) }}

Contenedores

Contenedor ancho

Utiliza este código corto si deseas tener una tabla, párrafo, bloque de código… más ancho. En escritorio, ocupará el ancho del encabezado. En móviles no tendrá efecto, excepto para las tablas, que ganarán scroll horizontal.

Uso

{% wide_container() %}

Coloca tu bloque de código, párrafo, tabla… aquí.

El Markdown, por supuesto, será interpretado.

{% end %}

Forzar dirección del texto

Fuerza la dirección del texto de un bloque de contenido. Anula tanto la configuración global force_codeblock_ltr como la dirección general del documento.

Acepta el parámetro direction: la dirección de texto deseada. Puede ser “ltr” (de izquierda a derecha) o “rtl” (de derecha a izquierda). Por defecto es “ltr”.

def مرحبا_بالعالم():
    print("مرحبا بالعالم!")

Uso

En una página LTR podemos forzar que un bloque de código sea RTL (como se muestra arriba) de la siguiente manera:

{% force_text_direction(direction="rtl") %}

```python
def مرحبا_بالعالم():
    print("مرحبا بالعالم!")
```

{% end %}