Skip to content

Latest commit

 

History

History
131 lines (87 loc) · 4.07 KB

ejemplo.md

File metadata and controls

131 lines (87 loc) · 4.07 KB
title author header-includes toc numbersections fontsize geometry
Tutorial de Markdown
Pablo Baeyens
false
false
11pt
margin=1in

Markdown 101

Markdown es un lenguaje de marcado ligero utilizado en páginas como Github (este documento está escrito en Markdown!). También puede compilarse a LaTeX utilizando herramientas como pandoc para generar pdfs.

Sintaxis

A continuación puedes ver ejemplos de la sintaxis básica. Para entender cómo funciona Markdown mira el código fuente de este documento a la vez que lo lees.

Títulos

Los títulos se indican con #. Hay hasta 6 niveles (######):

Título de tercer nivel

Título de cuarto nivel

Formato de texto

Podemos dar formato al texto con negrita, cursiva (o ambos) o monoespaciado.

También puedes poner citas:

GNU, which stands for Gnu's Not Unix, is the name for the complete Unix-compatible software system which I am writing so that I can give it away free to everyone who can use it.

En Github podemos además tener texto tachado o usar emojis :octocat:. Además podemos poner código con coloreado de sintaxis indicando el nombre del lenguaje:

main :: IO ()
main = putStrLn "hello world"

Listas

Las listas no numeradas se indican con - (hay que dejar una linea en blanco con el párrafo anterior):

  • Primer elemento
  • Segundo elemento
    • Subelemento del segundo
  • Tercer elemento

Si queremos que estén numeradas lo indicamos empezando con cualquier número seguido de un punto:

  1. Primer elemento
  2. Segundo elemento

En Github además tenemos listas de tareas:

  • Una tarea por hacer
  • Una tarea completada

Imágenes

Para incluir imágenes lo hacemos con la sintaxis ![Texto alternativo](url):

Meme de Doge de Wikimedia Commons

Enlaces

Los enlaces se indican con una sintaxis similar [texto](url). Quedan así. También puedes poner enlaces directamente entre ángulos:

http://www.omfgdogs.com

Cómo usarlo

Puedes usar Markdown en Github en un archivo con la extensión .md o en los comentarios, las issues y Github lo interpretará automáticamente.

Pandoc

⚠️ Atención: Algunas de las características que funcionan en Github no funcionaran cuando generes el pdf

Para generar pdfs puedes utilizar pandoc. Por ejemplo, si quieres generar un pdf a partir de este fichero basta utilizar el comando:

pandoc markdown.md -o markdown.pdf

Puede incluirse información adicional en la cabecera (escrita en YAML) para controlar distintos aspectos de la generación del PDF. Además, si lo necesitas, puedes incluir código directamente en LaTeX

Pro tip: Puedes añadir esta función a tu archivo ~/.bashrc para facilitar este proceso de generación de un pdf.

## Pandoc processing: Input: source file. Output: pdf processed file with
## the name of the original input file but swapped extension to pdf
##
## Usage: Pandoc file\ name.md
function Pandoc() {
    var=`echo "$1" | rev |  cut -d'.' -f2- | rev`
    var="$var.pdf"
    var=${var//\\//}
    input=$1
    input=${input//\\//}
    echo "Reading and compiling: $input"
    pandoc --latex-engine=xelatex "$input" -o "$var" && echo "Done, output: $var"
}

Ejemplo de uso:

Pandoc Apuntes\ asignatura.md