Repolode
Enviar
guodongxiaren

guodongxiaren/README

Referencia de sintaxis Markdown y archivo de prueba que muestra cómo se renderiza GitHub Flavored Markdown (GFM) en README, issues y wikis.

Ver en GitHubSitio web
Estrellas
7,064
Forks
7,039
Issues abiertos
55
Último commit
hace 12 meses

¿Qué es?

Este repositorio es una guía práctica de GitHub Flavored Markdown, la sintaxis Markdown ampliada que se usa en GitHub. Incluye encabezados, estilos de texto, imágenes, enlaces, listas, citas en bloque, resaltado de código, tablas, alertas, emoji, bloques diff y etiquetas HTML comunes, como secciones desplegables y contenido centrado.

Cada sección combina la sintaxis de origen con el resultado renderizado para que puedas ver exactamente cómo se mostrará cada elemento. Las mismas funciones de GFM están disponibles en los archivos README, los issues y las wikis de GitHub, por lo que este documento resulta útil como referencia rápida al redactar la documentación de un proyecto.

Funciones clave

  • 01Incluye encabezados, énfasis, tachado y listas anidadas.
  • 02Muestra la sintaxis de imágenes y enlaces, incluidos los enlaces con estilo de referencia.
  • 03Muestra bloques de código delimitados con resaltado según el lenguaje.
  • 04Incluye alineación de tablas, bloques de alerta y resaltado de diff.
  • 05Documenta trucos de HTML, como secciones desplegables y contenido centrado.

Casos de uso

  • Consultar la sintaxis de GFM al redactar un README o un issue.
  • Aprender a dar formato a tablas, listas de tareas y alertas en GitHub.
  • Comprobar cómo se escriben en HTML las secciones desplegables o los bloques centrados.

Antes de usarlo

  • Este archivo es una referencia de sintaxis de Markdown y un archivo de prueba; no es software instalable.

En colecciones

Generadores de sitios estáticos y herramientas de documentación

Temas

#markdown#gfm#readme#documentation#github#flavored

Preguntas frecuentes

¿Qué es README?
Referencia de sintaxis Markdown y archivo de prueba que muestra cómo se renderiza GitHub Flavored Markdown (GFM) en README, issues y wikis. Este repositorio es una guía práctica de GitHub Flavored Markdown, la sintaxis Markdown ampliada que se usa en GitHub. Incluye encabezados, estilos de texto, imágenes, enlaces, listas, citas en bloque, resaltado de código, tablas, alertas, emoji, bloques diff y etiquetas HTML comunes, como secciones desplegables y contenido centrado.
¿README es gratuito? ¿Qué licencia tiene?
README es open source bajo la licencia Unlicense. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿README sigue mantenido?
Sin commits en más de 6 meses. El último commit de README fue el 24 nov 2025.
¿Para qué puedo usar README?
Consultar la sintaxis de GFM al redactar un README o un issue. Aprender a dar formato a tablas, listas de tareas y alertas en GitHub. Comprobar cómo se escriben en HTML las secciones desplegables o los bloques centrados.
¿Dónde consigo README?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/guodongxiaren/README

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados

badges / shields

Shields.io es un servicio y una biblioteca NPM que genera badges de estado concisos en SVG y formato rasterizado para archivos README y páginas web.

DevOps y nube#badge#svg#status-badge
27,4 mil+23 esta semana5,6 milJavaScriptApache-2.0Bien mantenidoActualizado hace 22 horas