Puede usar pandoc en Linux para convertir entre más de 40 formatos de archivo. También puede usarlo para crear un sistema simple de documentos como código escribiendo en Markdown, almacenando en git y publicando en cualquiera de sus formatos compatibles.

Si tiene un documento en cualquiera de pandoc's muchos formatos de archivo compatibles de pandoc's , convertirlo a cualquiera de los otros es muy sencillo. Esa es una herramienta útil para tener!

Pero el poder real de pandoc hace evidente cuando lo usas como la base de un sistema simple de docs-as-code. La premisa de docs-as-code es adoptar algunas de las técnicas y principios del desarrollo de software y aplicarlos a la documentación escrita, especialmente para proyectos de desarrollo de software. Sin embargo, puede aplicarlo al desarrollo de cualquier tipo de documentación.

Los desarrolladores de software usan su editor favorito o entorno de desarrollo integrado (IDE) para escribir sus programas. El código que escriben se guarda en archivos de texto. Estos contienen el código fuente del programa.

Utilizan un sistema de control de versiones, o VCS (Git es el más popular), para capturar cambios en el código fuente a medida que se desarrolla y mejora. Esto significa que el programador tiene un historial completo de todas las versiones de los archivos de código fuente. Él o ella puede acceder rápidamente a cualquier versión anterior de un archivo. Git almacena archivos en un repositorio. Hay un repositorio local en la computadora de cada desarrollador y un repositorio central, compartido y remoto que a menudo está alojado en la nube.

Cuando están listos para producir una versión funcional del programa, usan un compilador para leer el código fuente y generar un ejecutable binario.

Al escribir sus documentos en un lenguaje de marcado ligero y basado en texto, puede usar un VCS para controlar la escritura de su versión. Cuando esté listo para distribuir o publicar un documento, puede usar pandoc para generar tantas versiones diferentes de su documentación como necesite, incluidas las basadas en web (HTML), procesadas por texto o compuestas (LibreOffice, Microsoft Word, TeX) , formato de documento portátil (PDF), libro electrónico (ePub), etc.

Puede hacer todo esto desde un conjunto de archivos de texto livianos controlados por versión.

Para instalar pandoc en Ubuntu, use este comando:

En Fedora, el comando que necesita es el siguiente:

En Manjaro, debe escribir:

Puede verificar qué versión ha instalado utilizando la opción --version :

Si usa pandoc sin ninguna opción de línea de comandos, también acepta entradas escritas. Simplemente presione Ctrl + D para indicar que ha terminado de escribir. pandoc espera que escriba en formato Markdown y genera una salida HTML.

Veamos un ejemplo:

Hemos escrito algunas líneas de Markdown y estamos a punto de presionar Ctrl + D.

Tan pronto como lo hagamos, pandoc genera la salida HTML equivalente.

pandoc embargo, para hacer algo útil con pandoc , realmente necesitamos usar archivos.

Markdown es un lenguaje de marcado ligero, y se da un significado especial a ciertos caracteres. Puede usar un editor de texto sin formato para crear un archivo Markdown.

Markdown se puede leer fácilmente, ya que no hay etiquetas visualmente engorrosas para distraer del texto. El formato en documentos Markdown se asemeja al formato que representa. A continuación se presentan algunos de los conceptos básicos:

Cubriremos más ejemplos de todos estos en la siguiente sección.

RELACIONADO: ¿Qué es Markdown y cómo se usa?

Las conversiones de archivos son sencillas. pandoc generalmente puede determinar con qué nombres de archivo está trabajando los formatos de archivo. Aquí, vamos a generar un archivo HTML a partir de un archivo Markdown. La opción -o (salida) le dice a pandoc el nombre del archivo que deseamos crear:

Nuestro archivo Markdown de muestra, sample.md, contiene la sección corta de Markdown que se muestra en la imagen a continuación.

Se crea un archivo llamado sample.html. Cuando hacemos doble clic en el archivo, nuestro navegador predeterminado lo abrirá.

Ahora, generemos un documento de texto con formato de documento abierto que podamos abrir en LibreOffice Writer:

El archivo ODT tiene el mismo contenido que el archivo HTML.

Un toque ordenado es el texto alternativo para la imagen que también se utiliza para generar automáticamente un título para la figura.

Las opciones -f (de) y -t (a) se utilizan para indicarle a pandoc qué formatos de archivo desea convertir. Esto puede ser útil si está trabajando con un formato de archivo que comparte una extensión de archivo con otros formatos relacionados. Por ejemplo, TeX y LaTeX usan la extensión “.tex”.

También estamos utilizando la opción -s (independiente) para que pandoc genere todos los preámbulos de LaTeX necesarios para que un documento sea un documento de LaTeX completo, autónomo y bien formado. Sin la opción -s (independiente), la salida seguiría siendo LaTeX bien formada que podría insertarse en otro documento de LaTeX, no se analizaría correctamente como un documento de LaTeX independiente.

Escribimos lo siguiente:

Si abre el archivo “sample.tex” en un editor de texto, verá el LaTeX generado. Si tiene un editor LaTeX, puede abrir el archivo TEX para ver una vista previa de cómo se interpretan los comandos de composición tipográfica LaTeX. Reducir la ventana para que se ajuste a la imagen de abajo hizo que la pantalla pareciera pequeña, pero, en realidad, estaba bien.

Utilizamos un editor de LaTeX llamado Texmaker. Si desea instalarlo en Ubuntu, escriba lo siguiente:

En Fedora, el comando es:

En Manjaro, use:

Probablemente esté comenzando a comprender la flexibilidad que proporciona pandoc . Puede escribir una vez y publicar en casi cualquier formato. Es una gran hazaña, pero los documentos se ven un poco vainilla.

Con las plantillas, puede dictar qué estilos usa pandoc cuando genera documentos. Por ejemplo, puede decirle a pandoc que use los estilos definidos en un archivo de Hojas de Estilo en Cascada (CSS) con la opción --css .

Hemos creado un pequeño archivo CSS que contiene el texto a continuación. Cambia el espacio por encima y por debajo del encabezado de nivel un estilo. También cambia el color del texto a blanco y el color de fondo a un tono de azul:

El comando completo está debajo: tenga en cuenta que también utilizamos la opción independiente ( -s ):

pandoc utiliza el estilo único de nuestro archivo CSS minimalista y lo aplica al encabezado de nivel uno.

Otra opción de ajuste que tiene disponible cuando trabaja con archivos HTML es incluir el marcado HTML en su archivo Markdown. Esto se pasará al archivo HTML generado como marcado HTML estándar.

Sin embargo, esta técnica debe reservarse para cuando solo está generando salida HTML. Si está trabajando con múltiples formatos de archivo, pandoc ignorará el marcado HTML para archivos que no sean HTML y se pasará a ellos como texto.

También podemos especificar qué estilos se usan cuando se generan archivos ODT. Abra un documento en blanco de LibreOffice Writer y ajuste los estilos de encabezado y fuente para satisfacer sus necesidades. En nuestro ejemplo, también agregamos un encabezado y pie de página. Guarde su documento como “odt-template.odt”.

Ahora podemos usar esto como una plantilla con la opción --reference-doc :

Compare esto con el ejemplo ODT de antes. Este documento utiliza una fuente diferente, tiene encabezados de colores e incluye encabezados y pies de página. Sin embargo, se generó a partir del mismo archivo Markdown “sample.md”.

Las plantillas de documentos de referencia se pueden usar para indicar diferentes etapas de la producción de un documento. Por ejemplo, puede tener plantillas que tengan marcas de agua “Borrador” o “Para revisión”. Se usaría una plantilla sin marca de agua para un documento finalizado.

Por defecto, pandoc usa el motor LaTeX PDF para generar archivos PDF. La forma más fácil de asegurarse de tener satisfechas las dependencias apropiadas de LaTeX es instalar un editor de LaTeX, como Texmaker.

Sin embargo, es una instalación bastante grande: Tex y LaTeX son bastante fuertes. Si el espacio de su disco duro es limitado, o sabe que nunca usará TeX o LaTeX, es posible que prefiera generar un archivo ODT. Luego, puede abrirlo en LibreOffice Writer y guardarlo como PDF.

El uso de Markdown como lenguaje de escritura tiene varias ventajas, que incluyen las siguientes:

RELACIONADO: ¿Qué es GitHub y para qué se utiliza?

Hay muchas más opciones y características dentro de pandoc que las que hemos cubierto aquí. Los procesos de conversión para la mayoría de los tipos de archivos se pueden ajustar y ajustar. Para obtener más información, consulte los excelentes ejemplos en la página web oficial (y extremadamente detallada) de pandoc.