[WIP] chore: reorganización archivos y reducción del uso de HTML #26
Conversation
There was a problem hiding this comment.
Este refactor tiene como idea general lo siguiente:
- Reducir el número de dependencias del proyecto (plugins y extensiones)
- Tomar ventaja de las cosas que Material MKDocs nos da por default (Cards, Grids, Variables)
- Simplificar el proceso de escritura eliminando la necesidad de código HTML en abundancia.
La retroalimentación es bienvenida.
| title: Voluntarios | ||
| --- | ||
|
|
||
| { width=150px .hero-logo } |
There was a problem hiding this comment.
Según sé, hay un parametro para que esto se defina en el frontmatter, pero tengo que buscarlo bien y hacerlo funcionar.
| # Comunidades | ||
|
|
||
| <div class="communities-grid"> | ||
| ## :fontawesome-solid-users: Comunidades Amigas |
There was a problem hiding this comment.
La configuración actual de Material ya nos daba los íconos sin necesidad de HTML, así que los reemplacé aquí
| <p>Jalisco</p> | ||
| </div> | ||
| </a> | ||
| <div class="grid cards" markdown> |
There was a problem hiding this comment.
La clase grid crea un CSS Grid automaticamente (esto se encarga del tema de Responsive)
La clase cards les agrega un container li, y ya venía por default con Material for MKDocs
|
|
||
| <div class="communities-grid"> | ||
| Estas empresas han abierto sus puertas para que la comunidad Python CDMX crezca, **gracias por su apoyo**. | ||
| { .centered-text } |
There was a problem hiding this comment.
Se están cambiando también los elementos HTML por referencias a clases CSS directas.
| ## :fontawesome-solid-star: Estadísticas 2023 | ||
|
|
||
| <div class="stats-grid"> | ||
| <div class="grid cards stats" markdown> |
There was a problem hiding this comment.
La clase stats acá se usa para darle el formato de Icono>Título en Verde> Texto a las Cards.
| - Cómo Contribuir: participa/como-contribuir.md | ||
| - Voluntarios: participa/voluntarios.md | ||
| - Ponentes: participa/ponentes.md | ||
| - Sedes: participa/sedes.md |
There was a problem hiding this comment.
Los archivos se transfirieron a la carpeta semántica acorde a la navegación, esto quiere decir que si el archivo está dentro del tab Participa, debe estar en la carpeta Participa
mkdocs.yml
Outdated
| icon: | ||
| repo: fontawesome/brands/github | ||
| # icon: | ||
| # repo: fontawesome/brands/github |
There was a problem hiding this comment.
Esto fue removido, ya que Fontawesome viene por default con Material MKDocs y el pymdownx.emoji extension que ya estaba aquí
|
|
||
| # Plugins | ||
| plugins: | ||
| - macros |
There was a problem hiding this comment.
Este lo tengo que remover (no está en uso)
mkdocs.yml
Outdated
|
|
||
| extra_javascript: | ||
| - js/custom.js | ||
| # extra_javascript: |
There was a problem hiding this comment.
No he visto necesidad del archivo de JS aún, necesito ayuda con las pruebas de las páginas actualizadas para ver si aún sirve de algo.
mkdocs.yml
Outdated
| # - abbr | ||
| # - admonition | ||
| # - def_list | ||
| # - footnotes |
There was a problem hiding this comment.
Se eliminaron varias de las extensiones que parecen no estar en uso
Las podemos traer de vuelta si vemos que necesitamos algo, pero con nuestro contenido actual no ha sido necesario.
1 participant
📝 Descripción
Breve descripción de los cambios realizados en este PR.
🎯 Tipo de Cambio
🔗 Issues Relacionados
Closes #[número del issue]
Relacionado con #[número del issue]
📋 Cambios Realizados
🧪 Pruebas Realizadas
mkdocs build)mkdocs serve)📸 Capturas de Pantalla
Si este PR incluye cambios visuales, incluye capturas de pantalla:
Antes
Después
🔍 Checklist
📝 Notas Adicionales
Agrega cualquier contexto adicional sobre el PR aquí.
🤝 ¿Necesitas ayuda?
Si tienes preguntas sobre este PR o necesitas ayuda, no dudes en preguntar en los comentarios.
Gracias por contribuir a Python CDMX Charlas! 🐍