Saltar a contenido

MkDocs

En este post veremos como crear páginas estáticas con MkDocs en un entorno de Python3 y luego desplegarlas con GitHubPages .

Instalación

Antes de instalar algo en Entornos Debian:

1
sudo apt update

Instalamos Python y Pip ya que MkDocs está desarrollado en Python:

1
2
sudo apt-get install python3.5
sudo apt-get install python3-pip

Instalamos el creador de entornos virtuales de Python para instalar los modulos necesarios en nuestro entorno:

1
sudo apt-get install python3-venv

Creamos el entorno:

1
python3 -m venv mkdocs_env

Activamos el entorno:

1
source mkdocs_env/bin/activate

Instalamos el generador de páginas estáticas MkDocs:

1
pip install mkdocs

Instalamos también una plantilla para nuestro sitio:

1
pip install mkdocs-material

Creación del sitio

Para empezar generamos un sitio estándar:

1
2
mkdocs new sitio1
cd sitio1

La configuración se realiza en el fichero

Para más documentación visita:
mkdocs.org
pages.github.com

De esta forma podrías insertar una imagen

1
2
![nombre de la imagen][img1]
![nombre de la imagen2][img2] 

O dos, sin ensuciar tu espacio de escritura.

1
2
[img1]: /ruta/a/la/imagen.jpg "Título alternativo"
[img2]: /ruta/a/la/imagen2.jpg "Título alternativo"