Más sobre listas¶

Markdown incluye una sintaxis que permite incluir listas de varios elementos en nuestros documentos. Con las extensiones, podemos aumentar las capacidades.

Además de las listas con viñetas (unordered) y numeradas (ordered) tenemos las listas de definiciones y las de tareas.

Listas de definiciones¶

Son listas de términos acompañados de una definición, algo así como un diccionario. por ejemplo:

Por ejemplo:

**Manzana**

:   Fruta comestible de la especie Malus domestica, el manzano común.
    Es una fruta pomácea de forma redonda y sabor dulce o agrio.

**Naranja**

:   Fruta cítrica obtenida del naranjo dulce (Citrus sinensis), 
    del naranjo amargo (Citrus aurantium) y de naranjos 
    de otras variedades o híbridos, de origen asiático.

Mostrará lo siguiente:

Manzana: Fruta comestible de la especie Malus domestica, el manzano común. Es una fruta pomácea de forma redonda y sabor dulce o agrio.
Naranja: Fruta cítrica obtenida del naranjo dulce (Citrus × sinensis), del naranjo amargo (Citrus × aurantium) y de naranjos de otras variedades o híbridos, de origen asiático.

Para que todo esto funcione, hay que activar la extensión def_list en el archivo mdocs.yml

markdown_extensions:
    - def_list

Entre dos términos con sus definiciones debe haber al menos una línea en blanco separadora. Los dos puntos deben ir seguidos de un espacio como mínimo.

Puede haber más de una definición asociada a un término:

Manzana

:   Fruta comestible de la especie Malus domestica, el manzano común.
    Es una fruta pomácea de forma redonda y sabor dulce o agrio.

Naranja

:   Fruta cítrica obtenida del naranjo dulce (Citrus sinensis), 
    del naranjo amargo (Citrus aurantium) y de naranjos 
    de otras variedades o híbridos, de origen asiático.
:   Color a medio camino entre el amarillo y el rojo.

O bien asociar la misma definición a más de un término:

Término 1
Término 2

:   Definición a

Término 3

:   Definición b

Como sucede con cualquier lista, una definición puede estar formada por varios párrafos:

Término 1

:   Definición con dos párrafos. Lorem ipsum 
    dolor sit amet, consectetuer adipiscing elit. Aliquam 
    hendrerit mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus.

:   Segunda definición para el término 1.

Término 2

:   Esta definición tiene un bloque preformateado, una cita y una lista.

        bloque preformateado.

    > cita
    > de dos líneas.

    1.  elemento primero
    2.  elemento segundo

Listas de tareas¶

La extensión Tasklist hace que, si anteponemos a los elementos de una lista los textos, [ ] o [x], se muestren en forma de casilla de verificación :

- [x] Tarea día 1
- [ ] Tareas día 2
    * [x] Mañana
    * [x] Mediodía
    * [ ] Tarde
- [ ] Tarea día 3

Muestra:

Hay que activar la extensión en mkdocs.yml:

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true

La opción custom_checkbox proporciona unas casillas de aspecto más vistoso. Suprimiéndola, tendremos unas casillas más "retro".

Las casillas pueden cambiar de estado pulsando sobre ellas con el ratón, pero esta es una característica poco útil, ya que los cambios no se guardan. Podemos desactivar esta característica con:

markdown_extensions:
  - pymdownx.tasklist:
      clickable_checkbox: false