Cómo editar

Estos apuntes están alojados en GitLab, una plataforma de colaboración en línea abierta e intuitiva.

En el menú de la izquierda de cada página aparece un enlace Edita esta página para editar su código en GitLab (tras darte de alta e ingresar en la plataforma). Aquí te explico lo que hay que saber para hacerlo.

Tras incorporar los cambios a GitLab, y siempre que no haya errores, la versión actualizada de la página estará disponible en esta dirección al cabo de unos minutos.

Markdown básico

El título de esta sección se ha escrito con el código ## Markdown básico. Las negrillas se escriben **negrillas** y las cursivas *cursivas*.

  • Hacer listas…
    1. … es muy…
    2. … fácil.
  • El código de esta lista es el siguiente:
* Hacer listas...
	1. ... es muy...
	2. ... fácil.
* El código de esta lista es el siguiente:

Notación matemática

Hugo entiende $\LaTeX$. Prueba de ello es que acabo de escribir $\LaTeX$. Lo entiende casi todo, pero son necesarias algunas modificaciones:

  • Subíndices: El símbolo _ se sustituye por \_, por tanto $\sum_{n\geq 0}a_n$ se escribe $\sum\_{n\geq 0}a\_n$.

  • Corchetes: El conjunto $\{0,1,2\}$ se escribe $\\{0,1,2\\}$, con doble barra inclinada \\.

  • Espacios: para añadir espacios debemos usar \\, y \\; ya que por ejemplo $(1 \; 2)$ da lugar a $(1 ; 2)$ mientras que $(1 \\; 2)$ produce $(1 \; 2)$.

  • Entornos tabulares: en vez de usar \\ para saltos de línea hay que usar \cr, así $\left(\begin{smallmatrix} 1 & 0 \cr 0 & 1 \end{smallmatrix}\right)$ es $\left(\begin{smallmatrix} 1 & 0 \cr 0 & 1 \end{smallmatrix}\right)$.

  • Caracteres especiales: para escribir $( c )$, $( r )$ y $[ x ]$ usa $( c )$, $( r )$ y $[ x ]$, con los espacios, ya que si en su lugar escribes $(c)$, $(r)$ y $[x]$ te sale $(c)$, $(r)$ y .

Entornos

Los entornos habituales se escriben de manera algo diferente. Por ejemplo, una definición y su código fuente:

Definición

Esto es una definición.

{{% definition %}}
Esto es una **definición**.
{{% /definition %}}

Están definidos los entornos definition, proposition, corollary, lemma, theorem, example, proof, remark, exercise y watch. Los tres últimos no tienen barra de título, por ejemplo:

{{% remark %}}
Esto es una **observación**.
{{% /remark %}}

Los teoremas pueden tener nombre.

Teorema (Nombre)

Esto es un teorema con nombre.

{{% theorem name="Nombre" %}}
Esto es un teorema con nombre. 
{{% /theorem %}}

Los ejemplos deben tener nombre porque es lo único que aparecerá en la barra del título.

Nombre del ejemplo

Esto es un ejemplo.

{{% example name="Nombre del ejemplo" %}}
Esto es un ejemplo.
{{% /example %}}

Las pruebas tienen un aspecto especial. Aparecen plegadas para no sobrecargar el contenido y se despliegan pulsando sobre ellas.

Prueba

{{% proof %}}
Esto es una prueba. Aparecen plegadas por defecto. 
{{% /proof %}}

Todos los entornos anteriores (excepto las pruebas) admiten etiquetas para hacer referencias.

Definición

Esto es una definición etiquetada como mi_def.

{{% definition label="mi_def" %}}
Esto es una definición etiquetada como *mi_def*. 
{{% /definition %}}

Markdown avanzado

Es sencillo crear enlaces y referencias a entornos etiquetados o secciones:

  • Aprende markdown en Wikipedia. Este enlace se escribe [Wikipedia](https://en.wikipedia.org/wiki/Markdown).

  • Pulsa aquí para ir a la sección titulada Notación matemática. En este caso el código es [aquí](#notación-matemática).

  • Pulsa aquí para ir a la definición etiquetada mi_def. Aquí el código es [aquí](#mi_def).

Los dos últimos ejemplos enlazan a contenidos de esta misma página. Para hacer una referencia a algún entorno de otra página hay que indicar la ruta. Se puede enlazar al criterio de Eisenstein desde aquí escribiendo [criterio de Eisenstein](../polynomials/#eisenstein) ya que es un teorema etiquetado eisenstein que está dentro del tema de Polinomios.

También es fácil insertar imágenes alojadas dentro del proyecto:

esto es una imagen

![esto es una imagen](../images/symmetric_difference.svg)

Edita en tu ordenador

Si vas a editar los apuntes de un modo más que ocasional, es probable que te resulte más cómodo procesar los cambios en tu ordenador y luego subirlos a GitLab. Te explico cómo.

  1. Instala Hugo y Git.

  2. Abre una terminal y ejecuta los siguientes comandos:

$ git clone --recurse-submodules https://gitlab.com/basicalgebra/algbas
$ cd algbas
$ hugo server
  1. Si pinchas aquí probablemente te aparecerá la vista previa en el navegador. Si no te aparece, mira los mensajes que genera el último comando. Debe aparecer una línea como la siguiente, que contiene la dirección web local correcta:
Web Server is available at https://localhost:1313/algbas/ (bind address 127.0.0.1)

Los ficheros de contenido se encuentran en el subdirectorio contents. Los puedes abrir y modificar con tu editor de texto favorito. Recuerda recargar la vista previa en el navegador cuando guardes los cambios.

La organización de contents en subdirectorios y ficheros se corresponde con la distribución jerárquica del contenido de la web, reflejada en la barra lateral. Esto también explica el encabezamiento de los ficheros de contenido, que aparece rodeado con +++.

Para subir los cambios realizados al repositorio de GitLab hacer falta aprender algo de Git.