La respuesta corta: usa un comentario HTML
Coloca la nota entre `<!--` y `-->`. Los renderizadores compatibles la tratan como un comentario HTML y no la presentan como texto visible.
No es una función independiente del Markdown básico. Si una plataforma bloquea o escapa el HTML sin procesar, el resultado puede cambiar.
# Informe semanal
<!-- Confirmar la cifra antes de publicar. -->
El proyecto sigue dentro del plazo.Informe semanal
El proyecto sigue dentro del plazo.| Necesidad | Opción | Límite |
|---|---|---|
| Nota de edición portable | <!-- nota --> | Debe admitirse HTML sin procesar |
| Nota exclusiva de Obsidian | %% nota %% | Otros visores pueden mostrarla |
| Información privada | No incluirla | Ocultar no equivale a proteger |
| Mostrar la sintaxis como ejemplo | Bloque de código | Los marcadores se verán literalmente |
Una nota oculta sigue formando parte del archivo
El comentario permanece en el `.md`. Cualquier persona que abra el archivo como texto, consulte el código de un repositorio o revise su historial puede leerlo.
Es adecuado para tareas como verificar una fecha, actualizar una captura o pedir una segunda revisión. No sirve como control de acceso ni como lugar temporal para una clave.
- Correcto: «Revisar este enlace antes del lanzamiento».
- Correcto: «Sustituir la imagen cuando llegue la versión final».
- Incorrecto: contraseñas, tokens, direcciones privadas o datos de clientes.
- Si debe desaparecer, elimínalo también del historial correspondiente.
Comentarios de una línea y de varias líneas
Una nota breve cabe en una línea. Para una revisión más larga, abre el comentario, escribe las líneas necesarias y ciérralo con `-->`.
Comprueba siempre el cierre. Un marcador incompleto puede ocultar contenido posterior o producir una salida diferente según el motor.
<!--
Pendiente:
- comprobar la fuente
- actualizar el gráfico
-->La lista no aparece en la vista renderizada, pero continúa en el archivo fuente.Qué ocurre en un README de GitHub
GitHub recomienda los comentarios HTML para ocultar contenido de la vista Markdown renderizada. El botón para ver el código permite seguir leyendo la nota en `README.md`.
Por eso un comentario puede ayudar a colaboradores, pero no debe contener nada que los visitantes del repositorio no puedan conocer.
## Instalación
<!-- Mantener este comando sincronizado con package.json. -->
```sh
npm install
```La advertencia no se ve en la página renderizada; sí aparece al abrir el código del README.El comentario `%%` pertenece a Obsidian
Obsidian admite comentarios inline y en bloque entre signos `%%`. La aplicación los muestra durante la edición y los oculta en la vista de lectura.
Esa comodidad tiene un coste de portabilidad: GitHub, un CMS o un visor CommonMark genérico pueden presentar los signos y la nota como texto corriente. Si el archivo circulará entre herramientas, prefiere el comentario HTML y verifica el destino.
La propuesta está lista. %%Pedir a Ana que revise el presupuesto.%%No hay garantía de que otro renderizador oculte el contenido.Dentro de un bloque de código no se oculta nada
Los bloques delimitados conservan sus caracteres de forma literal. Si escribes un comentario HTML dentro de una valla de código, el lector verá el ejemplo completo.
Esto es útil para documentación técnica. La etiqueta de lenguaje tras las comillas invertidas solo controla el resaltado; no activa comentarios de Markdown dentro del bloque.
```html
<!-- Este texto aparece como código. -->
<p>Ejemplo</p>
```Un bloque de código visible con el comentario y la etiqueta HTML.Por qué dos aplicaciones pueden mostrar resultados distintos
CommonMark reconoce comentarios dentro del HTML sin procesar, pero una aplicación puede desactivar ese HTML o limpiarlo por seguridad. Un exportador también puede conservar el comentario, eliminarlo o convertir los marcadores en texto.
Una vista previa local solo demuestra el comportamiento de ese renderizador. Prueba el archivo en el repositorio, CMS, generador o aplicación donde se publicará.
| Síntoma | Causa probable | Comprobación |
|---|---|---|
| La nota no se ve | Se acepta el comentario HTML | Abrir el código fuente |
| Se ven los marcadores | HTML desactivado o escapado | Revisar opciones del destino |
| Desaparece contenido posterior | Falta `-->` | Corregir la pareja de marcadores |
| El comentario no está en el HTML final | El saneador lo eliminó | Comparar origen y archivo exportado |
Una rutina segura antes de publicar
Decide primero dónde vivirá el documento. Después escribe solo notas breves y no sensibles, revisa tanto el código como el resultado y elimina los comentarios resueltos.
- Identifica el renderizador finalGitHub, Obsidian, un CMS y un generador estático no tienen por qué comportarse igual.
- Añade una nota inocuaEl comentario debe ayudar a editar, no esconder información confidencial.
- Comprueba origen y salidaMira la vista renderizada, el archivo sin procesar y cualquier descarga.
- Limpia lo resueltoBorra recordatorios que ya no aportan contexto a la siguiente revisión.
Herramientas relacionadas
Preguntas frecuentes
¿Cómo se escribe un comentario en Markdown?
Markdown no tiene un marcador propio universal. Cuando se admite HTML sin procesar, usa `<!-- comentario -->` para ocultar una nota de la vista renderizada.
¿Un comentario Markdown es privado?
No. Puede ocultarse en la página renderizada y seguir visible en el archivo, el repositorio, el historial o una descarga.
¿Funcionan los comentarios HTML en GitHub?
Sí. GitHub los documenta para ocultar contenido renderizado, pero la nota continúa en el código del archivo.
¿Qué significa `%% comentario %%`?
Es una extensión de Obsidian. No forma parte del Markdown portable y otros visores pueden mostrarla como texto.
¿Se puede escribir un comentario de varias líneas?
Sí. Coloca todas las líneas entre `<!--` y `-->` y comprueba que el cierre esté presente.
¿Por qué se ve mi comentario?
El destino puede bloquear HTML, escapar los marcadores o usar otra variante. Confirma además que la sintaxis no esté dentro de un bloque de código.
¿Qué ocurre dentro de una valla de código?
Los marcadores se muestran literalmente como parte del ejemplo; no se procesan como comentario.