ejemplos para github wiki, jekill, liquid, markdown
Informe: Ejemplos exactos de uso de GitHub Wiki, Markdown, Jekyll y Liquid
1. GitHub Wiki
-
Dónde se usa: Dentro de la pestaña “Wiki” de cualquier repositorio.
-
Ejemplo exacto: Documentación del proyecto, como una guía de instalación o preguntas frecuentes.
-
Ejemplo real:
En un proyecto de librería JavaScript, puedes crear una página llamadaInstalaciónen la wiki, escrita en Markdown, explicando cómo usarnpm install.
Acceso:https://github.com/usuario/repositorio/wiki/Instalación
2. Markdown (.md)
-
Dónde se usa: En archivos como
README.md,CONTRIBUTING.md, páginas de la wiki y también en sitios Jekyll. -
Ejemplo exacto:
ElREADME.mdde un repositorio donde se explica qué hace el proyecto, cómo instalarlo y cómo usarlo.-
Títulos (
#), listas (-), enlaces ([texto](url)), y bloques de código (```).
-
3. Jekyll
-
Dónde se usa: En GitHub Pages, cuando habilitas un sitio desde un repositorio (normalmente en
docs/o desde la ramagh-pages). -
Ejemplo exacto:
Crear un sitio web para un portafolio usando un tema como "minimal", y tener un archivoindex.mdcon un encabezado YAML (---) para que Jekyll lo procese.-
Carpeta:
/docs/index.md -
YAML front matter:
-
4. Liquid
-
Dónde se usa: Dentro de archivos HTML o Markdown procesados por Jekyll, como plantillas en
_layouts,_includeso incluso dentro de unindex.md. -
Ejemplo exacto:
Mostrar dinámicamente el título de la página:O crear una lista de publicaciones:
Resumen final
| Herramienta | Tipo de uso | Ejemplo típico |
|---|---|---|
| GitHub Wiki | Documentación interna del repo | Guías, instalación, configuración |
| Markdown | Formato de texto plano | README.md, wikis, posts |
| Jekyll | Generador de sitios web estáticos | Portfolios, blogs en GitHub Pages |
| Liquid | Plantillas dentro de Jekyll | Variables, condicionales, bucles en HTML o Markdown |
Comentarios
Publicar un comentario