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 llamada Instalación en la wiki, escrita en Markdown, explicando cómo usar npm 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:
    El README.md de 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 rama gh-pages).

  • Ejemplo exacto:
    Crear un sitio web para un portafolio usando un tema como "minimal", y tener un archivo index.md con un encabezado YAML (---) para que Jekyll lo procese.

    • Carpeta: /docs/index.md

    • YAML front matter:

      yaml
      --- layout: default title: Bienvenido ---

4. Liquid

  • Dónde se usa: Dentro de archivos HTML o Markdown procesados por Jekyll, como plantillas en _layouts, _includes o incluso dentro de un index.md.

  • Ejemplo exacto:
    Mostrar dinámicamente el título de la página:

    liquid
    <h1>{{ page.title }}</h1>

    O crear una lista de publicaciones:

    liquid
    {% for post in site.posts %} <li><a href="{{ post.url }}">{{ post.title }}</a></li> {% endfor %}

Resumen final

HerramientaTipo de usoEjemplo típico
GitHub WikiDocumentación interna del repoGuías, instalación, configuración
MarkdownFormato de texto planoREADME.md, wikis, posts
JekyllGenerador de sitios web estáticosPortfolios, blogs en GitHub Pages
LiquidPlantillas dentro de JekyllVariables, condicionales, bucles en HTML o Markdown

Comentarios

Entradas más populares de este blog

simulacion de oferta de trabajo

Flexbox clase 1

reflexion del frontend