Pregunta Comentarios en Markdown


¿Cuál es la sintaxis para almacenar un comentario en un archivo de reducción, p. un comentario CVS $ Id $ en la parte superior del archivo? No encontré nada en el proyecto de descuento.


956
2018-01-28 00:18


origen


Respuestas:


Creo que todas las soluciones propuestas anteriormente (aparte de las que requieren implementaciones específicas) hacen que los comentarios se incluyan en el HTML de salida, incluso si no se muestran.

Si desea un comentario que sea estrictamente suyo (los lectores del documento convertido no deberían poder verlo, incluso con "ver fuente"), podría (ab) usar las etiquetas de enlace (para usar con enlaces de estilo de referencia) que son disponible en la especificación de Markdown básica:

http://daringfireball.net/projects/markdown/syntax#link

Es decir:

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

O podrías ir más allá:

[//]: <> (This is also a comment.)

Para mejorar la compatibilidad de la plataforma (y para guardar una pulsación de tecla) también es posible usar # (que es un objetivo de hipervínculo legítimo) en lugar de <>:

[//]: # (This may be the most platform independent comment)

Para una portabilidad máxima, es importante insertar una línea en blanco antes y después de este tipo de comentarios, ya que algunos analizadores de Markdown no vinculan las definiciones con el texto normal. La investigación más reciente con Babelmark muestra que las líneas en blanco antes y después son importantes. Algunos analizadores emitirán el comentario si no hay una línea en blanco antes, y algunos analizadores excluirán la siguiente línea si no hay una línea en blanco después.

En general, este enfoque debería funcionar con la mayoría de los analizadores de Markdown, ya que es parte de la especificación principal. (incluso si el comportamiento cuando se definen múltiples enlaces, o cuando se define un vínculo pero nunca se utiliza, no se especifica estrictamente).


990
2018-01-02 15:18



Yo uso etiquetas HTML estándar, como

<!---
your comment goes here
and here
-->

Tenga en cuenta el triple tablero. La ventaja es que funciona con Pandoc al generar salida TeX o HTML. Hay más información disponible en pandoc-discuss grupo.


779
2018-01-28 15:36



Esta pequeña investigación prueba y refina la respuesta de Magnus

La sintaxis más independiente de la plataforma es

(empty line)
[comment]: # (This actually is the most platform independent comment)

Ambas condiciones son importantes:

  1. Utilizando # (y no <>)
  2. Con una línea vacía antes del comentario. La línea vacía después del comentario no tiene impacto en el resultado.

La estricta especificación Markdown CommonMark solo funciona según lo previsto con esta sintaxis (y no con <> y / o una línea vacía)

Para probar esto, utilizaremos Babelmark2, escrito por John MacFarlane. Esta herramienta verifica la representación de un código fuente particular en 28 implementaciones de Markdown.

(+ - pasado la prueba, - - no pasó, ? - deja algo de basura que no se muestra en el HTML renderizado).

Esto prueba las declaraciones anteriores.

Estas implementaciones fallan las 7 pruebas. No hay posibilidad de utilizar comentarios excluidos en el render con ellos.

  • cebe / markdown 1.1.0
  • cebe / markdown MarkdownExtra 1.1.0
  • cebe / markdown GFM 1.1.0
  • s9e \ TextFormatter (Fatdown / PHP)

116
2017-08-24 19:17



Si está utilizando Jekyll o OctopStyle también funcionará.

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

Las etiquetas de Liquid {% comment %} se analizan primero y se eliminan antes de que el procesador MarkDown llegue a él. Los visitantes no verán cuando intenten ver la fuente desde su navegador.


42
2018-04-05 02:57



Una alternativa es poner comentarios dentro de etiquetas HTML estilizadas. De esta manera, puede alternar su visibilidad según sea necesario. Por ejemplo, defina una clase de comentario en su hoja de estilo CSS.

.comment { display: none; }

Luego, el siguiente MARKDOWN mejorado

We do <span class="comment">NOT</span> support comments

aparece de la siguiente manera en un NAVEGADOR

We do support comments


33
2018-02-22 18:11



Esto funciona en GitHub:

[](Comment text goes here)

El HTML resultante se ve así:

<a href="Comment%20text%20goes%20here"></a>

Que es básicamente un enlace vacío. Obviamente, puedes leer eso en la fuente del texto renderizado, pero puedes hacerlo en GitHub de todos modos.


25
2018-04-19 00:19



Consulte también Critic Markup, respaldado por un número cada vez mayor de herramientas de reducción.

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.

15
2018-03-31 11:17



¿Qué tal si ponemos los comentarios en un bloque R no evaluativo y sin eco? es decir.,

```{r echo=FALSE, eval=FALSE}
All the comments!
```

Parece que funciona bien para mí.


11
2017-11-23 03:19



Divulgación: escribí el complemento.

Dado que la pregunta no especifica una implementación de rebaja específica, me gustaría mencionar el Plugin de comentarios para python-markdown, que implementa el mismo estilo de comentario de Pandoc mencionado anteriormente.


10
2017-08-22 10:00



<!--- ... --> 

No funciona en Pandoc Markdown (Pandoc 1.12.2.1). Los comentarios aún aparecían en html. Lo siguiente funcionó:

Blank line
[^Comment]:  Text that will not appear in html source
Blank line

Luego use la extensión + pie de página. Es esencialmente una nota al pie que nunca se referencia.


9
2018-02-23 16:13