web-dev-qa-db-fra.com

Comment créer une zone de texte pour une note dans Markdown?

J'écris un document en markdown. J'utilise le merveilleux pandoc pour créer des fichiers docx et tex à partir de la source de démarquage. J'aimerais avoir une zone de texte pour les astuces et les notes aux lecteurs comme le font souvent les livres de programmation. Je n'arrive pas à comprendre comment faire cela en démarquant. Pouvez vous aider?

markdownpandoc
25
TJB

Ce que je fais habituellement pour mettre un champ d’alerte (par exemple, une note ou un avertissement) dans les textes de démarques (non seulement lors de l’utilisation de pandoc, mais également chaque fois que cette démarque est prise en charge) entoure le contenu de deux lignes horizontales:

---
**NOTE**

It works with almost all markdown flavours (the below blank line matters).

---

qui ressemblerait à ceci:

REMARQUE

Cela fonctionne avec tous les types de démarques (la ligne vide ci-dessous est importante).

La bonne chose est que vous n'avez pas besoin de vous soucier de quel type de markdown est pris en charge ou quelle extension est installée ou activée.

EDIT: Comme @ filups21 l'a mentionné dans les commentaires, il semble qu'une ligne horizontale soit représentée par *** dans RMarkdown. La solution mentionnée précédemment ne fonctionne donc pas avec tous les types de démarques, comme elle l’avait été revendiquée à l’origine.

26
cartoonist

La solution la plus simple que j'ai trouvée au même problème consiste à utiliser un tableau à plusieurs lignes avec une ligne et aucun en-tête (il y a une image dans la première colonne et le texte dans la seconde):

----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
                        bla bla bla bla bla bla bla ... the
                        blank line below is important 

----------------------------------------------------------------

Une autre approche qui pourrait fonctionner (pour les PDF) consiste à utiliser la directive Latex default fbox:

 \fbox{My text!}

Ou module FancyBox pour des fonctionnalités plus avancées (et des boites plus esthétiques): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox .

11
Etienne Savard

Utilisez le admonition extension. Pour mkdocs , il peut être configuré dans le fichier mkdocs.yml:

markdown_extensions:
    - admonition

Ensuite, insérez la note dans vos fichiers md comme suit:

!!! note

     This is a note.

Voir un exemple ici .

6
Boni García

Avec GitHub, j'insère généralement un blockquote

NOTE:Le contenu de la note.

Bien sûr, il y a toujours du HTML simple ... 

6
Vlad

Voici un exemple simple à base de latex. 

---
header-includes:
    - \usepackage[most]{tcolorbox}
    - \definecolor{light-yellow}{rgb}{1, 0.95, 0.7}
    - \newtcolorbox{myquote}{colback=light-yellow,grow to right by=-10mm,grow to left by=-10mm, boxrule=0pt,boxsep=0pt,breakable}
    - \newcommand{\todo}[1]{\begin{myquote} \textbf{TODO:} \emph{#1} \end{myquote}}
---

blah blah

\todo{something}

blah

qui se traduit par:  enter image description here

Malheureusement, comme il s’agit de latex, vous ne pouvez plus inclure de démarquage dans la zone TODO (ce qui n’est pas un gros problème) et cela ne fonctionnera pas lors de la conversion vers des formats autres que PDF (par exemple, html). 

1
naught101

Vous pouvez également utiliser https://www.npmjs.com/package/markdown-it-container

::: warning
*here be dragons*
:::

Est-ce que rendu alors comme:

<div class="warning">
<em>here be dragons</em>
</div>
1
Alinex