Ajustando comandos en Markdown con Pandoc

Salida de comandos cortados

Cuando documentamos, algunas veces una línea de comando puede tener una gran longitud.
En la lectura del fichero escrito con sintaxis Markdown no hay problema, sin embargo a la hora de generar el PDF de esa documentación, puede suceder que el comando no se puede leer de forma completa, lo cual si se trata de una solución técnica podría ser un problema.

Supongamos que documentamos en nuestro manual en formato markdown una línea como esta:

```bash
echo "Esto es una linea superlag que quiero usar para comprobar la rotura del comando en diferentes lineas cuando se genera el documento para facilitar la visibilidad del comando a ejecutar en la documentacion"
```

Si nuestro comando pandoc (simplificado) es el siguiente para generar el manual:

pandoc --pdf-engine=xelatex manual.md -o manual.pdf

Cuando generemos el fichero PDF obtendriamos en el resultado el comando cortado y no es visible de forma correcta.

Evitar corte de comando

Para no modificar el fichero Markdown que seguramente quede en algún repositorio, para llevar el control de cambios del mismo.

Podemos optar por la solución de usar un fichero auxiliar que contenga una pequeña instrucción LaTex para que suceda la magia...
En mi caso suelo nombrarlo con la extensión .tex.md y con el mismo nombre del documento para facilitar su localización y uso.

En nuestro ejemplo si tenemos un fichero manual.md crearemos un fichero de nombre manual.tex.md

Dentro de este nuevo fichero simplemente escribimos:

header-includes:
  - \usepackage{fvextra}
  - \DefineVerbatimEnvironment{Highlighting}{Verbatim}{breaklines,commandchars=\\\{\}}

Ahora para poder generar el PDF incluimos en el comando de pandoc este fichero entre los ficheros de origen. El comando quedaría asi:

pandoc --pdf-engine=xelatex manual.tex.md manual.md -o manual.pdf

En cuanto se genere el PDF final, veremos que obtendríamos la línea del comando sin cortar y bien formateada:

Nota: Este artículo inicia la serie de etiquetas Píldoras en los que se mostraran soluciones a problemas y pequeños trucos con una solución sencilla.