- Crear (o ingresar al) entorno virtual:
mkvirtualenv changelog
workon changelog- Instalar los requerimientos:
pip install -r requirements.txt- Hacer los cambios requeridos en docs/index.md y en
vim docs/index.md
vim docs/changelog.md- Ver los cambios locales:
mkdocs serve- Construir el proyecto:
mkdocs build- Subir cambios al repositorio:
git commit -am "Comente sus cambios"
git push origin main- Desplegar el proyecto:
git pull
mkdocs gh-deploy- Verificar que no se haya borrado el dominio yendo a la siguiente ruta dentro del repositorio del changelog en Github:
Settings -> Pages -> Custom domain -> https://changelog.ikono.net.co
Nota: Puedes revisar la carpeta help, aquí encontrarás un PDF con ejemplos. También puedes encontrar ejemplos en mkdocs-material