La plantilla puede obtenerse haciendo un fork del siguiente repositorio (opción recomendable): https://github.com/jcsaezal/plantilla-TFG-pandoc-markdown
Alternativamente, se puede descargar el siguiente archivo ZIP: https://github.com/jcsaezal/plantilla-TFG-pandoc-markdown/archive/refs/heads/master.zip
$ cd $RAIZ_DEL_REPO
$ panbuild PDF
Se genera un fichero main.pdf, con la versión en PDF de la memoria. Para que todo funcione correctamente, es preciso instalar las herramientas que se describen a continuación.
En Linux se ha de instalar cada una de las siguientes utilidades:
- Pandoc v2.4 (la versión específica es crítica)
- TeX live versión completa (distribución de LaTeX para GNU/Linux)
- Python 3.x, pip, y panflute
- Herramienta Panbuild
- Filtros (extensiones) de Pandoc
- Opcionalmente
- Editor Typora (ojo, no es grauito)
- Editor Sublime Text 3
- Plugin para usar Panbuild desde Sublime Text
A continuación se proporciona información sobre cómo llevar a cabo la instalación de cada herramienta sobre distribuciones de Linux como Ubuntu o Debian, que están basadas en paquetes ".deb".
-
Descargar el paquete DEB disponible aquí.
-
Instalar pandoc ejecutando el siguiente comando desde una ventana de terminal (en el mismo directorio donde se encuentre el fichero descargado):
> sudo dpkg -i pandoc-2.4-1-amd64.deb
Para evitar errores al generar ficheros PDF con pandoc (debido a la complejidad de las plantillas por defecto) se recomienda instalar la versión completa de TeX Live usando los siguientes comandos:
> sudo apt-get update
> sudo apt-get install texlive-fullPara instalar Panbuild y los filtros básicos de Pandoc que usa la plantilla, es preciso instalar las herramientas pip y git en nuestro sistema. Para ello ejecutaremos el siguiente comando:
> sudo apt-get install python-pip gitNota: se recomienda la instalación de la extensión pandoc-crossref para hacer referencia cómodamente a figuras y tablas con Markdown. Usar el ejecutable descargable del siguiente enlace para instalarlo (en /usr/local/bin):
Existen dos métodos para instalar estas herramientas: (1) Mediante la creación de un virtual env de Python 3 --opción recomendable--, (2) instalando las herramientas de forma nativa en el sistema
Por comodidad, es aconsejable crear este virtual env de Python dentro del directorio principal de la plantilla. De este modo, cuando estemos editando el documento, tendremos el entorno en la misma ubicación.
Los pasos a seguir son los siguientes:
-
Desde el directorio correspondiente (p.ej, el de la plantilla), crear virtual env (Python 3.8 o superior)
> python3.8 -m venv venv3 > . venv3/bin/activate
-
Instalar dependencias desde dentro del virtual env (el comando anterior debería haber modificado el prompt)
> pip install --upgrade pip > pip install panflute==1.11.1
-
Una vez hecho esto, procederemos a instalar Panbuild --que reside en un repositorio de GitHub--, como sigue:
> pip install git+https://github.com/jcsaezal/panbuild -
Para instalar los filtros básicos de Panbuild es preciso ejecutar el siguiente comando:
> pip install git+https://github.com/dualmarkdown/dualmarkdown
-
Instalación de panflute
> sudo pip install panflute==1.11.1 -
Procederemos ahora a instalar Panbuild, como sigue:
> sudo pip install git+https://github.com/jcsaezal/panbuild -
Finalmente se instalan los filtros (extensiones) de Pandoc:
> sudo pip install git+https://github.com/dualmarkdown/dualmarkdown
Para instalar este editor pueden seguirse los pasos de cualquiera de estos tutoriales:
- Sublime Text's official documentation
- Cómo instalar Sublime Text 3 en Ubuntu y derivados
- Como instalar Sublime Text 3 en Ubuntu de la manera oficial
Se recomienda la instalación de la extensión "Package Control" de Sublime Text, para poder añadir fácilmente plugins.
Las instrucciones para instalar este plugin de forma manual se encuentran en el siguiente enlace: