plantilla-taller

Esta es una plantilla para usar en los talleres de La Jaquería. Está hecha con MKDocs y usando el tema Material Design (es muy completo y además se ve bien en móviles).

Pasos previos

1. Tienes que tener Python 3 instalado.
2. Tienes que instalar PIP, el gestor de paquetes de Python.

Es altamente recomendado que uses un editor de texto tipo Visual Studio Code / Visual Studio Codium, Atom, o similares para trabajar. Para esta plantilla se recomienda usar VSCode o VSCodium con las siguientes extensiones instaladas:

• Markdown All in One
• markdownlint
• TODO Highlight
• Todo Tree

Instalación

Esta plantilla está pensada para ser usada en un repositorio, aunque la puedes usar de manera local.

1. Crea un repositorio en tu Github para tu taller.
2. A ese repositorio creale una rama que se llame gh-pages.
3. En la sección Settings de tu repositorio, vete la parte de Github Pages y habilita la opción de usar la rama gh-pages.
4. Descarga / clona tu repo en tu pc y recuerda que todo el rato vamos a trabajar en la rama master.
5. Descarga / clona esta plantilla, plantilla-taller, en tu ordenador.
6. Copia de la rama master de plantilla-taller a la carpeta de tu taller:
   • Carpeta docs.
   • Fichero mkdocs.yml.
   • Fichero Pipfile (el Pipfile.lock no).
   • Fichero .gitignore (si no lo ves activa los ficheros ocultos).
   • Fichero LICENSE (si no quieres que tu taller tenga licencia MIT, cambia su contenido, pero por favor, ponle licencia a tu taller).
   • Es importante que la carpeta .git no la copies bajo ningún concepto.
7. Abre una terminal en la carpeta de tu taller.
8. Crea el entorno virtual e instala todas sus dependencias con

# Crear el entorno virtual
python -m venv env
# Activar el entorno virtual
source env/bin/activate
# Instalar las dependencias
pip install -r requirements.txt

Ahora tendrás preparado tu equipo para poder trabajar con la plantilla.

Como trabajar

Montar taller en local

Para poder ver el taller en local como si estuviera en Internet, es necesario que levantes su servidor de pruebas. Es tan sencillo como desde la terminal en la carpeta de tu taller hagas

# Activar el entorno virtual
source env/bin/activate
# Correr el servidor
mkdocs serve

Ahora en tu navegador podrás ver como va quedando tu taller en la web http://127.0.0.1:8000/.

Lista de tareas

Una vez abres el taller en la web, verás que en la página principal o home, tienes una lista de tareas. Esta página se corresponde al fichero docs/index.html. Ve siguiendo la lista de tareas y tendrás tu taller funcionando.