Edita el fichero miProyecto/src/documento.md con tu editor de texto favorito.
Edita el fichero miProyecto/src/documento.md con tu editor de texto
favorito.
Ejecuta:
Ejecuta:
make
- make
Para generar todos los ficheros de salida y el fichero README.md (equivale a *make all*)
Para generar todos los ficheros de salida y el fichero README.md
(equivale a *make all*)
make clean
- make clean
Para borrar todos los ficheros de salida
Para borrar todos los ficheros de salida
make reset
- make reset
Equivale a *make clean all*
Equivale a *make clean all*
Más detalles
## Más detalles
------------
El makefile está preparado para procesar **todos** los ficheros con extensión *.md* que haya en el directorio *src*. Esto permite escribir documentos largos y dividirlos en secciones, por ejemplo podríamos tener los siguientes documentos en el directorio *src*
El makefile está preparado para procesar **todos** los ficheros con
extensión *.md* que haya en el directorio *src*. Esto permite escribir
documentos largos y dividirlos en secciones, por ejemplo podríamos tener
los siguientes documentos en el directorio *src*
00_Comienzo.md
00_Comienzo.md
10_Capitulo_01.md
10_Capitulo_01.md
@ -40,23 +42,32 @@ El makefile está preparado para procesar **todos** los ficheros con extensión
30_Conclusion.md
30_Conclusion.md
40_apendices.md
40_apendices.md
Al ejecutar make nos crearía **un solo documento de salida** concatenando todos los ficheros. El orden en que los concatena es el orden en el que aparecen al hacer un *ls* por eso se nombran con una numeración al principio que permita ordenarlos a gusto del autor.
Al ejecutar make nos crearía **un solo documento de salida**
concatenando todos los ficheros. El orden en que los concatena es el
orden en el que aparecen al hacer un *ls* por eso se nombran con una
numeración al principio que permita ordenarlos a gusto del autor.
Si quieres cambiar el nombre del fichero de salida (*documento*) tendrás que editar el makefile y cambiar la línea:
Si quieres cambiar el nombre del fichero de salida (*documento*) tendrás
que editar el makefile y cambiar la línea:
target := documento
target := documento
Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados.
Otras líneas que puedes tocar en el makefile son las que especifican el
idioma y los tipos de letra usados.
¿Qué es Pandoc?
# ¿Qué es Pandoc?
===============
Como explican en http://pandoc.org, Pandoc es una librería en Haskell para hacer conversión de documentos de un formato markup a otro. Y también es una herramienta de terminal de comandos que usa esa librería.
Como explican en http://pandoc.org, Pandoc es una librería en Haskell
para hacer conversión de documentos de un formato markup a otro. Y
también es una herramienta de terminal de comandos que usa esa
librería.
Lo que nos permite Pandoc a la hora de documentar un proyecto es mantener la documentación en un formato abierto y sencillo (markdown) y generar salidas en distintos formatos (pdf, mediawiki, epub, html, etc) con un simple comando.
Lo que nos permite Pandoc a la hora de documentar un proyecto es
mantener la documentación en un formato abierto y sencillo (markdown) y
generar salidas en distintos formatos (pdf, mediawiki, epub, html, etc)
con un simple comando.
¿Qué necesitas tener instalado?
# ¿Qué necesitas tener instalado?
===============================
- Pandoc
- Pandoc
- make
- make
@ -64,15 +75,18 @@ 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
## 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.
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
## 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:
Hay muchas plantillas para generar documentación con Pandoc, puestas a
disposición de la comunidad. De momento nos hemos limitado a las
Esto dejará las plantillas en el directorio *~/.pandoc/templates* que es uno de los directorios donde Pandoc busca las plantillas.
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.
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
-----------------
Salvo que estemos dentro de un bloque de código o de "código en linea", **cualquier carácter de puntuación o espacio** precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato.
Salvo que estemos dentro de un bloque de código o de “código en linea”,
**cualquier carácter de puntuación o espacio** precedido de contrabarra
se tratará de forma literal, incluso si ese carácter normalmente indique
algún formato.
Bloque de título
## Bloque de título
----------------
Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene que ir al principio del documento
Es una forma rápida de indicar el título el autor o autores y la fecha.
Tiene que ir al principio del documento
% título
% título
% autor(es) (separados por :)
% autor(es) (separados por :)
% fecha
% fecha
Alternativamente se puede usar otro estilo para el bloque de título, mucho más completo, en formato [YAML](https://en.wikipedia.org/wiki/YAML), especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos.
Alternativamente se puede usar otro estilo para el bloque de título,
mucho más completo, en formato
[YAML](https://en.wikipedia.org/wiki/YAML), especificando variables. No
puede usarse simultáneamente con el anterior, hay que escoger entre los
dos estilos.
Se pueden especificar todo tipo de variables [1].
Se pueden especificar todo tipo de variables \[1\].
---
---
title: Título
title: Título
@ -121,20 +143,23 @@ Se pueden especificar todo tipo de variables [1].
...
...
---
---
Incrustar TeX y HTML
## Incrustar TeX y HTML
--------------------
- Los comandos TeX se pasan de forma transparente al Markdown, y afectan solo a la salida de LaTeX y ConTeXt; en el resto de casos se borran
- Los comandos TeX se pasan de forma transparente al Markdown, y
- El código HTML pasará a la salida sin cambios, pero el Markdown dentro de los bloques HTML se procesa como Markdown
afectan solo a la salida de LaTeX y ConTeXt; en el resto de casos se
borran
- El código HTML pasará a la salida sin cambios, pero el Markdown
dentro de los bloques HTML se procesa como Markdown
Párrafos y retornos de línea
## Párrafos y retornos de línea
----------------------------
- Un párrafo es una o más líneas de texto separadas por una linea en blanco del resto
- Un párrafo es una o más líneas de texto separadas por una linea en
- Una línea que termina con dos espacios, o una línea que termina con un fin de linea escapado (contrabarra seguida de retorno de linea) indica un cambio de linea manual
blanco del resto
- Una línea que termina con dos espacios, o una línea que termina con
un fin de linea escapado (contrabarra seguida de retorno de linea)
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)
- En la [guia de usuario de Pandoc](http://pandoc.org/README.html) Importante leersela para sacarle todo el jugo a esta herramienta
<!-- end list -->
- 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)
[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.
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
@ -72,7 +72,7 @@ No hay inconveniente en dejar las plantillas en otro directorio, o incluso en el
== Backslash Escapes ==
== Backslash Escapes ==
Salvo que estemos dentro de un bloque de código o de "código en linea", '''cualquier carácter de puntuación o espacio''' precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato.
Salvo que estemos dentro de un bloque de código o de “código en linea”, '''cualquier carácter de puntuación o espacio''' precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato.
== Bloque de título ==
== Bloque de título ==
@ -83,8 +83,7 @@ Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene
% fecha</pre>
% fecha</pre>
Alternativamente se puede usar otro estilo para el bloque de título, mucho más completo, en formato [https://en.wikipedia.org/wiki/YAML YAML], especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos.
Alternativamente se puede usar otro estilo para el bloque de título, mucho más completo, en formato [https://en.wikipedia.org/wiki/YAML YAML], especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos.
Se pueden especificar todo tipo de variables <ref>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.
Se pueden especificar todo tipo de variables <ref>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.</ref>.
</ref>.
<pre>---
<pre>---
title: Título
title: Título
@ -187,7 +186,7 @@ A) example
B) example</pre>
B) example</pre>
==== Listas desordenadas ====
==== Listas desordenadas ====
Los items de la lista deben ir marcados con '*', '+', or '-'.
Los items de la lista deben ir marcados con ‘*’, ‘+’, or ‘-’.
<pre>+ example
<pre>+ example
- example
- example
@ -251,6 +250,23 @@ Todo el texto identado cuatro espacios
<pre>Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
<pre>Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
tal cual y no en itálica.</pre>
tal cual y no en itálica.</pre>
== Notas a pie de página ==
<pre>Referencia[^1], y una nota[^larga]
[^1]: Cobbled together from
<http://daringfireball.net/projects/markdown/syntax> and
