Template for pandoc documents
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
salvari b2b735f540
Primera versión
10 years ago
out Primera versión 10 years ago
src Primera versión 10 years ago
README.md Primera versión 10 years ago
makefile Primera versión 10 years ago

README.md

This is incomplete and possibly incorrect. It is intended for quick reference purposes only.

Backslash Escapes

Except inside a code block or inline code, any punctuation or space character preceded by a backslash will be treated literally, even if it would normally indicate formatting.

Title Block

% title
% author(s) (separated by semicolons)
% date

Inline TeX and HTML

  • TeX commands are passed through to Markdown, LaTeX and ConTeXt output; otherwise they are deleted.
  • HTML is passed through untouched but
    • Markdown inside HTML blocks is parsed as markdown.

Paragraphs and line breaks

  • A paragraph is one or more lines of text separated by a blank line.
  • A line that ends with two spaces, or a line that ends with an escaped new-line (a backslash followed by a carriage return) indicates a manual line break.

Italics, bold, superscript, subscript, strikeout

*Italics* and **bold** are indicated with asterisks. 

To ~~strikeout~~ text use double tildas. 

Superscripts use carats, like so: 2^nd^. 

Subscripts use single tildas, like so: H~2~O. 

Spaces inside subscripts and superscripts must be escaped, 
e.g., H~this\ is\ a\ long\ subscript~.

Inline TeX math and Inline Code

Inline TeX math goes inside dollar signs: $2 + 2$. 

Inline code goes between backticks: `echo 'hello'`.

Links and images

<http://example.com>
<foo@bar.com>
[inline link](http://example.com "Title")
![inline image](/path/to/image, "alt text")

[reference link][id]
[implicit reference link][]
![reference image][id2]

[id]: http://example.com "Title"
[implicit reference link]: http://example.com
[id2]: /path/to/image "alt text"

Footnotes

Inline notes are like this.^[Note that inline notes cannot contain multiple paragraphs.] Reference notes are like this.[^id]

[^id]:  Reference notes can contain multiple paragraphs.

    Subsequent paragraphs must be indented.

Citations

Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].

Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

Blah blah [@smith04; @doe99].

Smith says blah [-@smith04].

@smith04 says blah.

@smith04 [p. 33] says blah.

Headers

Header 1
========

Header 2
--------

# Header 1 #

## Header 2 ##

Closing #s are optional. Blank line required before and after each header.

Lists

Ordered lists

1. example
2. example

A) example
B) example

Unordered lists

Items may be marked by '*', '+', or '-'.

+   example
-   example
*   example

Lists may be nested in the usual way:

+   example
    +   example
+   example

Definition lists

Term 1
  ~ Definition 1
Term 2
  ~ Definition 2a
  ~ Definition 2b

Term 1
:   Definition 1
Term 2
:   Definition 2
    Second paragraph of definition 2.

Blockquotes

>   blockquote
>>  nested blockquote

Blank lines required before and after blockquotes.

Tables

  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.

(For more complex tables, see the pandoc documentation.)

Code Blocks

Begin with three or more tildes; end with at least as many tildes:

~~~~~~~
{code here}
~~~~~~~

Optionally, you can specify the language of the code block:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
qsort []     = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
               qsort (filter (>= x) xs) 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Horizontal Rules

3 or more dashes or asterisks on a line (space between okay)

---
* * *
- - - -

% Pandoc Cheatsheet[1] % Sergio Alvariño copiado descaradamente de David Sanson % Abril 2016

Solo para referencia rápida y personal.

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.

Bloque de título

Es una forma rápida de indicar el título el autor o autores y la fecha.

% título
% autor(es) (separados por :)
% fecha

Un bloque de título mucho más completo:

---
title: Título
author:
- Autor Uno <autor.uno@gmail.com>
- Otro autor <otroautor@gmail.com>
tags: [nothing, nothingness]
date: enero-2016
lang: es-ES
abstract: |
  Este es el resumen.

  Con dos párrafos.
...

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
  • 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

  • Un párrafo es una o más líneas de texto separadas por una linea en 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) indica un cambio de linea manual

Itálica, negrita, superescrito, subesctrito, tachado

*Itálica* and **negrita** se indican con asteriscos.

Para  ~~tachar~~ texto usa tildes dobles.

Superscrito se indica así: 2^ndo^.

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~.

TeX matématico o código incrustado en linea

El TeX matemático va entre signos$: $2 + 2$.

El código en linea va entre comillas invertidas: `echo 'hello'`

Enlaces e imágenes

<http://example.com>
<foo@bar.com>
[inline link](http://example.com "Title")
![inline image](/path/to/image, "alt text")

[reference link][id]
[implicit reference link][]
![reference image][id2]

[id]: http://example.com "Title"
[implicit reference link]: http://example.com
[id2]: /path/to/image "alt text"

Notas al pie de página

Las notas en linea son como esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] Las notas de referencia son como esta.[^id]

[^id]:  Las notas de referencia pueden contener varios párrafos.

    Los parámetros a continuación deben estar identados.

Citas

Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].

Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

Blah blah [@smith04; @doe99].

Smith says blah [-@smith04].

@smith04 says blah.

@smith04 [p. 33] says blah.

Encabezados

Encabezado 1
========

Encabezado 2
--------

# Encabezado 1 #

## Encabezado 2 ##

Las almohadillas de cierre # son opcionales. Es necesario añadir una línea en blanco antes y después de cada cabecera.

Listas

Listas Ordenadas

1. example
2. example

A) example
B) example

Lisas desordenadas

Los items de la lista deben ir marcados con '*', '+', or '-'.

+   example
-   example
*   example

Las listas se pueden anidar de la forma usual:

+   example
    +   example
+   example

Listas de definición

Term 1
  ~ Definition 1
Term 2
  ~ Definition 2a
  ~ Definition 2b

Term 1
:   Definition 1
Term 2
:   Definition 2
    Second paragraph of definition 2.

Blockquotes

>   blockquote
>>  nested blockquote

Es necesario añadir lineas en blanco antes y después de los bloques-cita.

Tablas

  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.

(Para tablas más complejas consulta la documentación de Pandoc.)

Bloques de código

Los bloques de código empiezan con tres o más tildes; y acaban por lo menos con el mismo número de tildes:

~~~~~~~
{code here}
~~~~~~~

Opcionalmente, se puede especificar el lenguaje que corresponde al bloque de código:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
qsort []     = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
               qsort (filter (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Lineas horizontales

3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados)

---
* * *
- - - -

Bloques verbatim

Todo el texto identado cuatro espacios

Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
tal cual y no en itálica.

[1] Cobbled together from http://daringfireball.net/projects/markdown/syntax and http://johnmacfarlane.net/pandoc/README.html.