Añadida sección de instalación de Pandoc

multilingue
salvari 8 years ago
parent 5472ad2da0
commit 245b44a627

@ -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*)
- 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:
``` {bash}
cd
mkdir .pandoc
cd .pandoc
git clone https://github.com/jgm/pandoc-templates templates
```
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
====================
@ -203,7 +224,7 @@ Listas
#### Listas desordenadas
Los ítems de la lista deben ir marcados con '\*', '+', or '-'.
Los items de la lista deben ir marcados con '\*', '+', or '-'.
+ example
- example
@ -284,8 +305,8 @@ Todo el texto identado cuatro espacios
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
- 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.

Binary file not shown.

Binary file not shown.

@ -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'')
* 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:
<pre class="{bash}">cd
mkdir .pandoc
cd .pandoc
git clone https://github.com/jgm/pandoc-templates templates</pre>
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 =
== 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,
p.ej., H~esto\ es \ un\ subescrito~.</pre>
== TeX matématico o código incrustado en linea ==
== TeX matemático o código incrustado en linea ==
<pre>El TeX matemático va entre signos$: $2 + 2$.

Binary file not shown.

@ -175,6 +175,35 @@ instalado?}\label{quuxe9-necesitas-tener-instalado}
Un buen editor de texto
\end{itemize}
\subsection{Instalación de Pandoc}\label{instalaciuxf3n-de-pandoc}
Los paquetes de Pandoc están disponibles en la
\href{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.
\subsection{Instalación de plantillas de
Pandoc}\label{instalaciuxf3n-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:
\begin{verbatim}
cd
mkdir .pandoc
cd .pandoc
git clone https://github.com/jgm/pandoc-templates templates
\end{verbatim}
Esto dejará las plantillas en el directorio
\emph{\textasciitilde{}/.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
\emph{makefile} para que Pandoc las encontrara sin problemas.
\section{Chuletario de Pandoc}\label{chuletario-de-pandoc}
\subsection{Backslash Escapes}\label{backslash-escapes}
@ -264,8 +293,8 @@ Los espacios en el superescrito y el subescrito tienen que ir escapados,
p.ej., H~esto\ es \ un\ subescrito~.
\end{verbatim}
\subsection{TeX matématico o código incrustado en
linea}\label{tex-matuxe9matico-o-cuxf3digo-incrustado-en-linea}
\subsection{TeX matemático o código incrustado en
linea}\label{tex-matemuxe1tico-o-cuxf3digo-incrustado-en-linea}
\begin{verbatim}
El TeX matemático va entre signos$: $2 + 2$.

@ -90,6 +90,33 @@ etc) con un simple comando.
* Las plantillas de Pandoc (o *templates*)
* 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:
~~~~{bash}
cd
mkdir .pandoc
cd .pandoc
git clone https://github.com/jgm/pandoc-templates templates
~~~~
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
@ -164,7 +191,7 @@ dentro de los bloques HTML se procesa como Markdown
Los espacios en el superescrito y el subescrito tienen que ir escapados,
p.ej., H~esto\ es \ un\ subescrito~.
## TeX matématico o código incrustado en linea
## TeX matemático o código incrustado en linea
El TeX matemático va entre signos$: $2 + 2$.

Loading…
Cancel
Save