Todos los cambios del tema de la plantilla son documentados en este fichero.
Se necesita Pipenv para trabajar con la plantilla. Se adjunta el Pipfile
para levantar todo limpiamente.
# Instalar Pipenv
pip install pipenv
# Crear virtualenv e instalar todo
pipenv install
# Levantar la web para ver los cambios -> http://127.0.0.1:8000/
pipenv run mkdocs serve
# Guardar los cambios y subirlos a Github
pipenv run mkdocs gh-deploy
La plantilla se ha creado con MKDocs porque es muy fácil de usar y mezcla Markdown + Python.
Se ha usado el tema Material Design porque es probablemente el más completo, y además es responsivo (por si se quiere leer en móvil o tablet).
La siguiente entrada ha sido de gran ayuda para aprender a customizar el tema. Aunque es un curso de C, en la sección Markdown explica como funciona el tema material.
En el fichero mkdocs.yml
es donde está toda la customización.