Guía rápida de Markdown: sintaxis con vista previa en vivo

Todos los elementos de Markdown con su código y su vista previa, la sintaxis extendida (tablas, listas de tareas, notas al pie, fórmulas matemáticas, Mermaid, alertas), una tabla de compatibilidad con 9 plataformas y un editor de prueba en vivo.

Última verificación: 2026-10-18, contrastado con CommonMark 0.31.2, la especificación GFM y la documentación de formato de GitHub, GitLab, Obsidian, Slack y Jira. Fuentes: CommonMark spec 0.31.2, GitHub Flavored Markdown spec, GitHub writing and formatting docs, GitLab Flavored Markdown, Obsidian help, Slack message formatting, Jira text formatting notation.

32 elementos

Sintaxis básica (funciona en todo lo compatible con CommonMark)

Estos elementos están en la especificación CommonMark, así que se comportan igual en GitHub, GitLab, VS Code, Obsidian, generadores de sitios estáticos y la mayoría de herramientas de documentación.

Encabezados#

De uno a seis # seguidos de un espacio. Usa un solo encabezado # por documento y no te saltes niveles; los lectores de pantalla y los índices dependen del orden.

Markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
Resultado
Heading 1
Heading 2
Heading 3
Heading 4
Encabezados subrayados#

El estilo "setext", más antiguo; solo niveles 1 y 2. Una línea de --- bajo un párrafo lo convierte en encabezado, lo que sorprende a quien espera una línea horizontal: deja una línea en blanco antes de ---.

Markdown
Heading 1
=========

Heading 2
---------
Resultado
Heading 1
Heading 2
Párrafos#

Una línea en blanco separa los párrafos. Un salto de línea simple dentro de un párrafo se une en una sola línea (salvo donde se indica en saltos de línea).

Markdown
First paragraph, which can wrap
across several source lines.

Second paragraph after a blank line.
Resultado

First paragraph, which can wrap across several source lines.

Second paragraph after a blank line.

Saltos de línea#

Para un salto de línea sin nuevo párrafo, termina la línea con dos espacios o una barra invertida. Los comentarios de GitHub, Obsidian (por defecto), Slack y Discord tratan cada salto de línea como salto.

Markdown
Two trailing spaces  
make a break.
A trailing backslash\
works too.<br>So does an HTML br.
Resultado

Two trailing spaces
make a break. A trailing backslash
works too.
So does an HTML br.

Negrita y cursiva#

Los asteriscos funcionan dentro de palabras; los guiones bajos no (nombres_en_snake_case se quedan literales), por eso la mayoría de guías de estilo prefieren *.

Markdown
**bold** or __bold__

*italic* or _italic_

***bold italic***

in**side**word works with *, not with _
Resultado

bold or bold

italic or italic

bold italic

insideword works with *, not with _

Cita#

Empieza cada línea con >. Las citas pueden contener cualquier otro Markdown, incluidas listas y código.

Markdown
> Quoted text.
> Still quoted.
>
> > Nested quote.
Resultado

Quoted text. Still quoted.

Nested quote.

Lista con viñetas#

-, * o + funcionan; no los mezcles en una misma lista (otro marcador empieza una lista nueva).

Markdown
- Item
- Item
  - Nested (indent 2 spaces)
- Item
Resultado
  • Item
  • Item
    • Nested (indent 2 spaces)
  • Item
Lista numerada#

El primer número fija el inicio; los siguientes se ignoran, así que con "1." en todas las líneas la lista se renumera sola al reordenar elementos.

Markdown
1. First
1. Second
1. Third

3. Starts at three
4. Four
Resultado
  1. First

  2. Second

  3. Third

  4. Starts at three

  5. Four

Párrafos y código dentro de listas#

Sangra el contenido adicional para alinearlo con el primer carácter del texto del elemento (3 espacios después de "1. ").

Markdown
1. Install:

   ```sh
   npm install marked
   ```

2. Indent continuation lines
   to the item text.
Resultado
  1. Install:

    npm install marked
    
  2. Indent continuation lines to the item text.

Código en línea#

El Markdown entre comillas invertidas no se interpreta.

Markdown
Run `npm test` now.

Use ``double `backticks` `` when the code contains one.
Resultado

Run npm test now.

Use double `backticks` when the code contains one.

Bloque de código#

Tres comillas invertidas (o ~~~) en líneas propias. La palabra tras la apertura indica el lenguaje para el resaltado de sintaxis en GitHub, GitLab, Obsidian y Discord.

Markdown
```js
const answer = 42;
console.log(answer);
```
Resultado
const answer = 42;
console.log(answer);
Bloque de código con sangría#

La sintaxis original. Las vallas son más claras y permiten indicar el lenguaje; el código con sangría es la única forma que entiende el Reddit antiguo.

Markdown
Paragraph.

    four spaces of indent
    make a code block
Resultado

Paragraph.

four spaces of indent
make a code block
Línea horizontal#

Tres o más -, * o _ en una línea propia, con una línea en blanco encima.

Markdown
Above

---

Below (also *** or ___)
Resultado

Above


Below (also *** or ___)

Imágenes#

Como un enlace con ! delante. El texto entre [ ] es el texto alternativo: describe la imagen para quien no puede verla. Markdown no tiene sintaxis de tamaño; usa HTML <img width="200"> donde se permita HTML.

Markdown
![Site logo](/brand/favicon.svg "Optional title")

[![Clickable image](/brand/favicon.svg)](/tools)
Resultado

Site logo

Clickable image

Escapar caracteres#

Una barra invertida hace literal cualquier signo de puntuación ASCII: \ ` * _ { } [ ] ( ) # + - . ! |

Markdown
\*not italic\*  \# not a heading  1\. not a list
Resultado

*not italic* # not a heading 1. not a list

HTML en línea#

CommonMark lo permite. GitHub y GitLab conservan un subconjunto seguro (sin script, style ni manejadores de eventos); Slack, Discord, Reddit y Notion lo muestran como texto.

Markdown
Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.
Resultado

Press Ctrl + C, H2O, x2.

Comentarios ocultos#

Un comentario HTML se conserva en el código fuente pero no se muestra allí donde se permite HTML.

Markdown
Visible.

<!-- Not rendered: notes for editors -->

Also visible.
Resultado

Visible.

Also visible.

Sintaxis extendida (GFM y compañía)

No forma parte de CommonMark. La compatibilidad varía, así que consulta la tabla de compatibilidad antes de usarla fuera de GitHub.

Tablas#

La segunda línea es obligatoria; los dos puntos fijan la alineación. Las columnas no tienen que estar alineadas en el código. Escapa una barra vertical literal como \|. No hay celdas combinadas ni multilínea (usa <br> dentro de una celda en GitHub).

Dónde: GFM, GitLab, Obsidian, Reddit; Notion al pegar

Markdown
| Left | Centre | Right |
| :--- | :----: | ----: |
| a    |   b    |     1 |
| `c`  | **d**  |    22 |
Resultado
Left Centre Right
a b 1
c d 22
Listas de tareas#

En GitHub y GitLab las casillas se pueden marcar en issues y pull requests y actualizan el código fuente.

Dónde: GFM, GitLab, Obsidian; Notion con el atajo []

Markdown
- [x] Write the draft
- [ ] Review
- [ ] Publish
Resultado
  • Write the draft
  • Review
  • Publish
Tachado#

Dos virgulillas en todas partes; GitHub también acepta una. Slack usa ~una~ virgulilla, Jira -guiones-.

Dónde: GFM, GitLab, Obsidian, Discord, Reddit, Notion

Markdown
~~no longer true~~
Resultado

no longer true

Notas al pie#

La definición puede ir en cualquier parte; las notas se numeran por orden de referencia y se listan al final. Obsidian también tiene notas en línea: ^[así].

Dónde: GFM, GitLab, Obsidian (no CommonMark)

Markdown
Markdown was created in 2004.[^1]

[^1]: By John Gruber, with Aaron Swartz.
Cómo lo muestra GitHub / Obsidian

Markdown was created in 2004.1


  1. By John Gruber, with Aaron Swartz. ↩
ID de encabezado personalizados#

Defines tú el ancla. Compatible con Pandoc, PHP Markdown Extra, Hugo, Jekyll (kramdown), MkDocs y Docusaurus; GitHub y GitLab lo ignoran y muestran las llaves, y usan ids automáticos.

Dónde: Pandoc, Hugo, Jekyll, MkDocs, Docusaurus; no GitHub ni GitLab

Markdown
### Install {#setup}
Cómo lo muestra GitHub / Obsidian
Install

Rendered by Pandoc, Hugo or kramdown with id="setup", so /page#setup links here.

Códigos cortos de emoji#

Nombres entre dos puntos. Al escribir dos puntos en GitHub, Slack, Discord o Notion se abre un selector de emojis. Pegar el propio emoji funciona en todas partes.

Dónde: GitHub, GitLab, Slack, Discord; no Obsidian (sin plugin) ni CommonMark

Markdown
Ship it :rocket: :+1: :tada:
Cómo lo muestra GitHub / Obsidian

Ship it 🚀 👍 🎉

Fórmulas (LaTeX)#

TeX entre signos $ en línea, $$ para un bloque destacado. GitHub también acepta $`…`$ y un bloque ```math; GitLab admite las mismas formas. Notion usa $$…$$ para ecuaciones en línea.

Dónde: GitHub, GitLab, Obsidian, Notion (sintaxis propia)

Markdown
Inline: $E = mc^2$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
Cómo lo muestra GitHub / Obsidian

Inline: E = mc2

∑i=1n i = n(n+1) ⁄ 2

Diagramas Mermaid#

Un bloque de código con el lenguaje mermaid se convierte en diagrama: diagramas de flujo, de secuencia, de clases, de estados, de Gantt y ER.

Dónde: GitHub, GitLab, Obsidian, Notion (bloque de código Mermaid)

Markdown
```mermaid
flowchart LR
  A[Write] --> B{Review}
  B -->|ok| C[Publish]
  B -->|changes| A
```
Cómo lo muestra GitHub / Obsidian
Avisos / alertas#

GitHub tiene cinco tipos: NOTE, TIP, IMPORTANT, WARNING, CAUTION. GitLab (17.10+) acepta la misma sintaxis. Obsidian tiene muchos más tipos, títulos personalizados (> [!tip] Título) y plegado (> [!faq]-).

Dónde: GitHub, GitLab 17.10+, Obsidian; una cita normal en los demás

Markdown
> [!NOTE]
> Useful information.

> [!WARNING]
> Critical content that needs attention.
Cómo lo muestra GitHub / Obsidian
ⓘ Note

Useful information.

⚠ Warning

Critical content that needs attention.

Sección desplegable#

Es HTML, pero con amplia compatibilidad. Deja líneas en blanco alrededor del Markdown interior o no se interpretará.

Dónde: GitHub, GitLab, Obsidian, la mayoría de generadores de sitios estáticos

Markdown
<details>
<summary>Click to expand</summary>

Hidden **Markdown** content.

</details>
Resultado
Click to expand

Hidden Markdown content.

Resaltado#

Obsidian y algunos editores (Typora, iA Writer); GitHub muestra los signos igual. Usa <mark> donde se permita HTML.

Dónde: Obsidian, Typora; no GitHub

Markdown
This is ==highlighted== text.
Cómo lo muestra GitHub / Obsidian

This is highlighted text.

Compatibilidad: CommonMark, GitHub, GitLab, Obsidian, Notion, Slack, Discord, Reddit, Jira

✓ funciona tal cual · ~ funciona con otra sintaxis o solo en parte (ver nota) · ✗ no disponible. Notion y el editor de Slack convierten los atajos de Markdown mientras escribes en lugar de renderizar un archivo Markdown; los campos de Jira Data Center usan marcado wiki, mientras que el editor de Jira Cloud acepta atajos de estilo Markdown al escribir.

FunciónCommonMarkGitHub (GFM)GitLabObsidianNotionSlack (mrkdwn)DiscordRedditJira wiki
Encabezados #✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
Atajos # , ## , ### al escribir
✗ No
Usa líneas en *negrita*
~ En parte / otra sintaxis
Solo #, ## y ###
✓ Sí~ En parte / otra sintaxis
h1. a h6.
Negrita / cursiva✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
*negrita* y _cursiva_ (caracteres simples)
✓ Sí
También __subrayado__
✓ Sí~ En parte / otra sintaxis
*negrita* y _cursiva_
Tachado✗ No✓ Sí
~~ o ~
✓ Sí✓ Sí✓ Sí
~texto~ o ~~texto~~
~ En parte / otra sintaxis
~texto~
✓ Sí✓ Sí~ En parte / otra sintaxis
-texto-
Código en línea✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
{{monospace}}
Bloque de código cercado✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
``` funciona, sin resaltado por lenguaje
✓ Sí~ En parte / otra sintaxis
Nuevo Reddit y apps; old.reddit necesita sangría de 4 espacios
~ En parte / otra sintaxis
{code:java} … {code}
Resaltado de sintaxis~ En parte / otra sintaxis
El lenguaje se pasa al renderizador; el resaltado depende de él
✓ Sí✓ Sí✓ Sí✓ Sí
Elige el lenguaje en el bloque
✗ No✓ Sí✗ No✓ Sí
{code:language}
Cita >✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
Escribe " y espacio; > y espacio crea un desplegable
✓ Sí✓ Sí
>>> cita el resto del mensaje
✓ Sí~ En parte / otra sintaxis
bq. o {quote} … {quote}
Listas✓ Sí✓ Sí✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
El editor convierte "- " en lista; no hay sintaxis de listas en mrkdwn de la API
✓ Sí✓ Sí~ En parte / otra sintaxis
* viñetas, # números, ** para anidar
Imágenes ![alt](url)✓ Sí✓ Sí✓ Sí✓ Sí
También ![[file.png]]
~ En parte / otra sintaxis
Al importar o pegar
✗ No
Súbelas en su lugar
✗ No
Adjunta o pega un enlace
✗ No
Súbelas en el editor
~ En parte / otra sintaxis
!image.png!
Tablas✗ No✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
Las tablas Markdown pegadas se convierten en tablas simples
✗ No✗ No✓ Sí~ En parte / otra sintaxis
||encabezado|| y |celda|
Listas de tareas✗ No✓ Sí✓ Sí
También [~] para no aplicable
✓ Sí~ En parte / otra sintaxis
[] y espacio crea una tarea
✗ No✗ No✗ No✗ No
Notas al pie✗ No✓ Sí✓ Sí✓ Sí
También en línea ^[nota]
✗ No✗ No✗ No✗ No✗ No
Anclas de encabezados✗ No~ En parte / otra sintaxis
Solo automáticas, sin {#id}
~ En parte / otra sintaxis
Solo automáticas
~ En parte / otra sintaxis
Enlaza con [[#Encabezado]]
~ En parte / otra sintaxis
Copia un enlace al bloque
✗ No✗ No✗ No~ En parte / otra sintaxis
{anchor:name}
Códigos cortos de emoji :smile:✗ No✓ Sí✓ Sí✗ No
Requiere plugin
~ En parte / otra sintaxis
Al escribir : se abre un selector
✓ Sí✓ Sí✗ No~ En parte / otra sintaxis
Emoticonos de texto como :) :D (y)
Fórmulas $…$✗ No✓ Sí✓ Sí✓ Sí~ En parte / otra sintaxis
$$…$$ en línea, /equation para bloques
✗ No✗ No✗ No✗ No
Diagramas Mermaid✗ No✓ Sí✓ Sí✓ Sí✓ Sí
Bloque de código configurado como Mermaid
✗ No✗ No✗ No✗ No
Requiere una app del Marketplace
Avisos > [!NOTE]✗ No✓ Sí
5 tipos
✓ Sí
17.10+
✓ Sí
Muchos tipos, plegables
✗ No
Usa /callout
✗ No✗ No✗ No~ En parte / otra sintaxis
{panel} … {panel}
HTML sin procesar✓ Sí~ En parte / otra sintaxis
Subconjunto seguro; sin script, style ni iframes
~ En parte / otra sintaxis
Subconjunto seguro
~ En parte / otra sintaxis
Subconjunto sanitizado
✗ No✗ No✗ No✗ No✗ No
Salto simple = salto de línea✗ No
Dos espacios finales o \
~ En parte / otra sintaxis
En comentarios sí, en archivos .md no
~ En parte / otra sintaxis
En comentarios sí, en archivos no
~ En parte / otra sintaxis
Sí, salvo que esté activado "Saltos de línea estrictos"
✓ Sí
Shift+Enter en un bloque
✓ Sí✓ Sí✗ No
Dos espacios finales
~ En parte / otra sintaxis
Salto de línea sí; \\ fuerza uno

Lo mismo, con otra sintaxis

Las parejas que confunden al pegar entre herramientas: Slack y Jira usan un solo * para la negrita, y en los enlaces de Slack la URL va primero.

ElementoMarkdown / GFMSlack mrkdwnDiscordRedditJira wiki
Negrita**bold***bold***bold****bold***bold*
Cursiva*italic*_italic_*italic**italic*_italic_
Tachado~~text~~~text~~~text~~~~text~~-text-
Subrayado(ninguno; <ins> en HTML)(ninguno)__text__(ninguno)+text+
Código en línea`code``code``code``code`{{code}}
Bloque de código```js … `````` … ``````js … ```4-space indent{code:js} … {code}
Encabezado## Title(ninguno)## Title## Titleh2. Title
Cita> text> text> text> textbq. text
Lista con viñetas- item• item (typed)- item- item* item
Lista numerada1. item1. item (typed)1. item1. item# item
Spoiler<details> (HTML)(ninguno)||text||>!text!<(ninguno)

Zona de pruebas de Markdown

Vista previa (CommonMark + GFM)
Release notes

Version 2.0 is out. Read the full changelog.

What changed
  • Faster start-up
  • New dark mode
  • Legacy API removed
Platform Status
Web ✅
Desktop beta
  • Write notes
  • Publish
npm install my-app@2

Questions? Reply to this post.

Se renderiza con marked en tu navegador; no se sube nada. Las notas al pie, las fórmulas, Mermaid y las alertas aparecen aquí como texto plano porque son extensiones de cada plataforma. ¿Necesitas un archivo de Word? Pega el Markdown en ChatGPT a Word. ¿Cuentas palabras? Usa el contador de palabras.

Las vistas previas y la zona de pruebas se renderizan en tu navegador; nada de lo que escribes se envía a ningún sitio. Ver todas las herramientas gratis.

¿Encontraste un problema o algo que podría mejorar? Leemos todos los mensajes y lo arreglamos rápido.

Esta guía rápida de Markdown muestra cada elemento dos veces: el Markdown que escribes y cómo se ve, uno al lado del otro, para que puedas copiar el código y saber qué vas a obtener. Primero lo básico (encabezados, énfasis, listas, enlaces, imágenes, código) y después la sintaxis extendida que la mayoría de la gente necesita de verdad en GitHub: tablas, listas de tareas, tachado, notas al pie, alertas, fórmulas matemáticas y diagramas Mermaid.

Markdown no es un único lenguaje. CommonMark define el núcleo; GitHub y GitLab añaden sus propias extensiones; Obsidian y Notion añaden más; Slack, Discord, Reddit y Jira usan cada uno algo parecido a Markdown con reglas distintas, como *asteriscos simples* para la negrita en Slack y Jira. La tabla de compatibilidad muestra qué funciona en cada sitio, y la tabla de equivalencias da la sintaxis exacta para cada herramienta de chat o de tickets. Las vistas previas se generan con la biblioteca de código abierto marked (CommonMark más GFM); las funciones que no implementa muestran cómo las ven GitHub u Obsidian. Al final, un pequeño editor de prueba renderiza lo que escribas, en tu navegador.

Cómo usarla

  1. Busca un elemento (tabla, casilla, nota al pie, salto de línea) o salta a una sección con las etiquetas de la parte superior.
  2. Copia el Markdown de la izquierda de cualquier tarjeta; la derecha muestra cómo se ve.
  3. Consulta la tabla de compatibilidad antes de usar una extensión fuera de GitHub, y la tabla de equivalencias cuando pegues en Slack, Discord, Reddit o Jira.
  4. Pega tu propio texto en el editor de prueba para previsualizarlo, y después copia el HTML o descarga un archivo .md.

Preguntas frecuentes

¿Cómo hago una tabla en Markdown?

Escribe la fila de encabezado con barras verticales, después una fila separadora de guiones y después las filas de datos: | Name | Age |, luego | --- | --- |, luego | Ana | 31 |. Los dos puntos en la fila separadora definen la alineación (:--- izquierda, :---: centro, ---: derecha). Las tablas son una extensión de GitHub Flavored Markdown, compatible con GitHub, GitLab, Obsidian, Reddit y la mayoría de los editores, pero no con CommonMark puro, Slack ni Discord.

¿Cómo añado un salto de línea sin empezar un párrafo nuevo?

Termina la línea con dos espacios o una barra invertida, o usa <br> donde se permita HTML. Si no, en CommonMark y en los archivos .md de GitHub un solo salto de línea se une al mismo párrafo. Los comentarios de GitHub, Obsidian (por defecto), Slack y Discord tratan cada salto de línea como un salto de línea; por eso el mismo texto puede verse distinto en un README y en un issue.

¿Qué diferencia hay entre CommonMark y GitHub Flavored Markdown?

CommonMark es una especificación precisa de la sintaxis original de Markdown. GitHub Flavored Markdown (GFM) es un superconjunto estricto que añade tablas, listas de tareas, tachado, enlaces automáticos ampliados y un filtro para el HTML inseguro. En github.com, las notas al pie, las alertas, las fórmulas matemáticas, los diagramas Mermaid y los códigos cortos de emoji se añaden encima de GFM mediante el procesamiento propio de GitHub.

¿Cómo escribo una casilla o una lista de tareas en Markdown?

Usa un elemento de lista que empiece por [ ] para una tarea pendiente o [x] para una hecha: - [ ] Revisar, - [x] Escribir borrador. GitHub y GitLab muestran casillas en las que se puede hacer clic en los issues y pull requests, Obsidian las marca y desmarca en la vista de lectura, y GitLab también acepta [~] para una tarea que no aplica.

¿Slack admite Markdown?

En parte, con sus propias reglas llamadas mrkdwn: *negrita* con asteriscos simples, _cursiva_, ~tachado~ con virgulillas simples, `código` y bloques de código ```, citas con > y enlaces escritos como <https://url|texto> en los mensajes enviados por la API. No hay encabezados, tablas ni imágenes. El editor de mensajes de Slack también convierte parte del formato mientras escribes, y Block Kit tiene un bloque markdown aparte que acepta Markdown estándar.

¿Cómo añado una nota al pie en Markdown?

Pon [^1] donde va la referencia y defínela en su propia línea en cualquier parte del documento: [^1]: La fuente. GitHub, GitLab y Obsidian numeran las notas al pie por orden de uso y las listan al final con enlaces de vuelta. CommonMark, Slack, Discord, Reddit y Notion no tienen notas al pie.

Cómo escribir Markdown que se vea igual en todas partes

• Deja una línea en blanco antes y después de los encabezados, las listas, los bloques de código, las tablas y los bloques HTML. Muchos problemas de “¿por qué no se ve bien?” son una línea en blanco que falta.

• Usa bloques de código delimitados con un lenguaje (```python) en lugar de sangría; son más claros y tienen resaltado de sintaxis.

• Usa * para el énfasis en lugar de _, porque CommonMark ignora los guiones bajos dentro de las palabras (nombres_en_snake_case), pero los renderizadores antiguos los tratan de otra forma.

• Elige un solo carácter de viñeta por lista; cambiar de - a * empieza una lista nueva.

• Sangra el contenido de las listas anidadas para que quede alineado con el texto del elemento padre, no con dos o cuatro espacios fijos.

• Escribe un texto alternativo para cada imagen. Se muestra cuando la imagen no carga y lo leen en voz alta los lectores de pantalla.

Lo esencial de un README en GitHub

GitHub muestra el README.md que esté en la raíz, en docs/ o en .github/. Los encabezados reciben anclas automáticamente, y GitHub crea con ellos un índice (el botón de esquema en la vista del archivo), así que una estructura de encabezados clara es el índice. Los enlaces e imágenes relativos (./docs/setup.md, ./images/demo.png) funcionan en github.com y siguen funcionando en los forks y en otras ramas, a diferencia de las URL absolutas.

Las alertas (> [!NOTE], > [!WARNING]) destacan las advertencias de instalación, los bloques de código Mermaid dibujan diagramas de arquitectura que siguen siendo editables, y <details> pliega secciones largas como las referencias de configuración completas. Dedica la primera pantalla a qué es el proyecto, cómo instalarlo y un ejemplo mínimo; todo lo demás puede ir debajo.

Herramientas gratis relacionadas

  • ChatGPT a Word — Pega una respuesta de ChatGPT, Claude o Gemini y cópiala en Word, Google Docs o un correo con títulos, tablas y listas de verdad en lugar de ** y #.
  • Contador de palabras — Cuenta palabras, caracteres, oraciones y tiempo de lectura, y comprueba los límites de X, LinkedIn, Instagram, YouTube, SEO y SMS mientras escribes.
  • Guía rápida de Git — Comandos de Git organizados según lo que quieres hacer: deshacer el último commit, renombrar una rama, eliminar una rama remota. Los comandos modernos switch/restore con sus equivalentes clásicos y avisos de peligro.
  • Guía rápida de regex — Todos los tokens de expresiones regulares con un ejemplo que funciona, su compatibilidad en JavaScript, PCRE/PHP, Python, Go, Java y .NET, y un enlace Pruébalo que abre el probador de regex ya relleno.
  • Comparador de textos — Compara dos versiones de un texto, código o archivo JSON y ve exactamente qué líneas, palabras y caracteres cambiaron.