Para instalar el proyecto se debe tener una version de python 3.11
pip3 install -r requirements.txtLuego debe realizar un pull de los submodulos (el theme)
git submodule update --init --recursive --remoteLuego podra hacer los pulls del submodulo con el siguiente comando
git submodule update --recursive --remotePara correr el servidor de desarrollo de debe ejecutar el archivo StartServer.ps1, este settea las variables de entorno correspondiente, levanta un servidor local en http://127.0.0.1:8000. Para que el reload por cada cambio sea automatico se debe ejecutar StartServer.ps1 -R o StartServer.ps1 --reload
Es recomendable leer la documentacion oficial de Pelican para entender mejor como agregar nueva funcionalidad
Para crear una nueva pagina, el archivo debe estar en /pages, ésta debe tener un formato de markdown (es posible introducir codigo html). El archivo debe contener una metadata como el siguiente
Title: Preguntas Frecuentes (obligatorio)
Slug: fqa (obligatorio)
Authors: Alejo Villores (obligatorio)
Summary: preguntas frecuentes de los alumnos (opcional)
Position: 3 (obligatorio)
### PaginaLa hoja de estilo depende de un submodulo de github pelican-theme. Es posible cambiar los estilos, colaborando tambien a a ese repositorio que es a su vez un fork de un theme ya realizado por un tercero.
Las contribuciones se deben hacer hacia la rama main
- Haz un fork del proyecto.
- Crea tu rama de características (
git checkout -b feature/AmazingFeature). - Confirma tus cambios (
git commit -m 'Añade una característica increíble'). - Haz push a la rama (
git push origin feature/AmazingFeature). - Abre un Pull Request.
Proximamente, cada pull request lanzará un workflow para subir a gh-pages los nuevos cambios
Este proyecto está bajo la Licencia MIT - consulta el archivo LICENSE para más detalles.
Cualquier duda, queja o sugerencia que no se pueda realizar desde el mismo repo, por favor enviar un mail a avillores@fi.uba.ar