@ -64,6 +64,27 @@ Lo que nos permite Pandoc a la hora de documentar un proyecto es mantener la doc
- Las plantillas de Pandoc (o *templates*)
- Las plantillas de Pandoc (o *templates*)
- Un buen editor de texto
- Un buen editor de texto
Instalación de Pandoc
---------------------
Los paquetes de Pandoc están disponibles en la [página de descargas del proyecto](http://pandoc.org/installing.html). En el caso de Ubuntu se instala sin más que descargar el paquete y abrirlo con el Centro de Software.
Instalación de plantillas de Pandoc
-----------------------------------
Hay muchas plantillas para generar documentación con Pandoc, puestas a disposición de la comunidad. De momento nos hemos limitado a las plantillas del creador de Pandoc:
Esto dejará las plantillas en el directorio *~/.pandoc/templates* que es uno de los directorios donde Pandoc busca las plantillas.
No hay inconveniente en dejar las plantillas en otro directorio, o incluso en el arbol de nuestro proyecto, pero habría que retocar el *makefile* para que Pandoc las encontrara sin problemas.
Chuletario de Pandoc
Chuletario de Pandoc
====================
====================
@ -203,7 +224,7 @@ Listas
#### Listas desordenadas
#### Listas desordenadas
Los ítems de la lista deben ir marcados con '\*', '+', or '-'.
Los items de la lista deben ir marcados con '\*', '+', or '-'.
+ example
+ example
- example
- example
@ -284,8 +305,8 @@ Todo el texto identado cuatro espacios
En que me he basado (o copiado si lo prefieres)
En que me he basado (o copiado si lo prefieres)
===============================================
===============================================
- En la [guía de usuario de Pandoc](http://pandoc.org/README.html) Importante leérsela para sacarle todo el jugo a esta herramienta
- En la [guia de usuario de Pandoc](http://pandoc.org/README.html) Importante leersela para sacarle todo el jugo a esta herramienta
- En la [chuleta de Pandoc](https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown) de [David Sanson](https://github.com/dsanson), perfecta para referencia rápida
- En la [chuleta de Pandoc](https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown) de [David Sanson](https://github.com/dsanson), perfecta para referencia rápida
- Para hacer el makefile me he leido varios tutoriales y copiado descaradamente de varios sitios que olvidé apuntar (lo siento)
- Para hacer el makefile me he leido varios tutoriales y copiado descaradamente de varios sitios que olvidé apuntar (lo siento)
[1] Ojo por que en el makefile propuesto se especifica el lenguaje, así que la variable del bloque de título no va a tener efecto en este caso.
[1] Ojo por que en el makefile propuesto se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso.
@ -52,6 +52,22 @@ Lo que nos permite Pandoc a la hora de documentar un proyecto es mantener la doc
* Las plantillas de Pandoc (o ''templates'')
* Las plantillas de Pandoc (o ''templates'')
* Un buen editor de texto
* Un buen editor de texto
== Instalación de Pandoc ==
Los paquetes de Pandoc están disponibles en la [http://pandoc.org/installing.html página de descargas del proyecto]. En el caso de Ubuntu se instala sin más que descargar el paquete y abrirlo con el Centro de Software.
== Instalación de plantillas de Pandoc ==
Hay muchas plantillas para generar documentación con Pandoc, puestas a disposición de la comunidad. De momento nos hemos limitado a las plantillas del creador de Pandoc:
Esto dejará las plantillas en el directorio ''~/.pandoc/templates'' que es uno de los directorios donde Pandoc busca las plantillas.
No hay inconveniente en dejar las plantillas en otro directorio, o incluso en el arbol de nuestro proyecto, pero habría que retocar el ''makefile'' para que Pandoc las encontrara sin problemas.
= Chuletario de Pandoc =
= Chuletario de Pandoc =
== Backslash Escapes ==
== Backslash Escapes ==
@ -106,7 +122,7 @@ Subescrito con tildes simples, así: H~2~O.
Los espacios en el superescrito y el subescrito tienen que ir escapados,
Los espacios en el superescrito y el subescrito tienen que ir escapados,