tutorial texto sheet examples español escribir ecuaciones como cheat centrar syntax comments markdown

syntax - texto - r markdown pdf



Comentarios en Markdown (14)

¿Cuál es la sintaxis para almacenar un comentario en un archivo de rebajas, por ejemplo, un comentario de CVS $ Id $ en la parte superior del archivo? No encontré nada en el proyecto markdown .

¿Qué tal si ponemos los comentarios en un bloque no-eval, non-echo R? es decir,

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

Parece que funciona bien para mí.

Creo que todas las soluciones propuestas anteriormente (aparte de aquellas 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 para usted (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 están disponible en la especificación básica de Markdown:

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 lejos:

[//]: <> (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 lograr la máxima portabilidad, es importante insertar una línea en blanco antes y después de este tipo de comentarios, ya que algunos analizadores de Markdown no funcionan correctamente cuando las definiciones se comparan con el texto regular. 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 Markdown, ya que es parte de la especificación central. (incluso si el comportamiento cuando se definen múltiples enlaces, o cuando un enlace se define pero nunca se usa, no se especifica estrictamente).

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 ningún impacto en el resultado.

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

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

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

Esto prueba las afirmaciones anteriores.

Estas implementaciones fallan las 7 pruebas. No hay posibilidad de usar los comentarios excluidos en el renderizado con ellos.

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

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.

Para pandoc, una buena forma de bloquear los comentarios es usar un metabloque yaml, como lo sugiere el autor de pandoc . Me he dado cuenta de que esto proporciona un resaltado de sintaxis más adecuado de los comentarios en comparación con muchas de las otras soluciones propuestas, al menos en mi entorno ( vim , vim-pandoc y vim-pandoc-syntax ).

Utilizo los comentarios del bloque yaml en combinación con los comentarios html-inline, ya que los comentarios html no se pueden anidar . Desafortunadamente, no hay forma de bloquear los comentarios dentro del metabloque de yaml , por lo que cada línea debe ser comentada individualmente. Afortunadamente, solo debe haber una línea en un párrafo envuelto en software.

En mi ~/.vimrc , he configurado accesos directos personalizados para comentarios de bloque:

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down> nmap <Leader>v {jddx}kdd

Yo uso , como mi <Leader> Cabezal <Leader> -key, así ,b y ,v comentan y descomentan un párrafo, respectivamente. Si necesito comentar varios párrafos, asigno j,b a una macro (generalmente Q ) y ejecuto <number-of-paragraphs><name-of-macro> (por ejemplo, ( 3Q ). Lo mismo funciona para no comentar).

Puedes probar

[]( Your comments go here however you cannot leave // a blank line so fill blank lines with // Something )

Si está utilizando Jekyll o Octopress, también funcionará.

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

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

También vea el marcado de crítica, con el apoyo de un número creciente de herramientas de Markdown.

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.

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

.comment { display: none; }

Entonces, lo siguiente mejorado MARKDOWN

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

Aparece como sigue en un NAVEGADOR

We do support comments

Yo uso etiquetas HTML estándar, como

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

Tenga en cuenta el triple guión. La ventaja es que funciona con pandoc al generar salidas TeX o HTML. Más información está disponible en el grupo pandoc-discuss .

Instant-Markdown usuarios de Vim Instant-Markdown necesitan usar

<!--- First comment line... // _NO_BLANK_LINES_ARE_ALLOWED_ // _and_try_to_avoid_double_minuses_like_this_: -- // last comment line. -->

kramdown el motor de kramdown basado en Ruby que es el predeterminado para Jekyll y, por lo tanto, GitHub Pages, tiene soporte para comentarios integrado a través de su sintaxis de extensión :

{::comment} This text is completely ignored by kramdown - a comment in the text. {:/comment} Do you see {::comment}this text{:/comment}? {::comment}some other comment{:/}

Esto tiene la ventaja de permitir comentarios en línea, pero la desventaja de no ser portátil a otros motores Markdown.

Divulgación: escribí el plugin.

Dado que la pregunta no especifica una implementación de reducción de rendimiento específica, me gustaría mencionar el Complemento de Comentarios para python-markdown , que implementa el mismo estilo de comentario de pandoc mencionado anteriormente.

<!--- ... -->

No funciona en Pandoc Markdown (Pandoc 1.12.2.1). Los comentarios todavía aparecieron en html. Lo siguiente funcionó:

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

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