Ich schreibe ein Dokument in Abschrift. Ich benutze das wunderbare Pandoc, um DocX- und Tex-Dateien aus der Markdown-Quelle zu erstellen. Ich hätte gerne ein Textfeld für Tipps und Notizen für Leser, wie es Programmierbücher oft tun. Ich kann nicht herausfinden, wie das in Markdown geht. Kannst du helfen?
86
Antworten:
Was ich normalerweise mache, um Warnfelder (z. B. Hinweis oder Warnung) in Markdown-Texte einzufügen (nicht nur bei Verwendung von Pandoc, sondern auch überall dort, wo dieser Markdown unterstützt wird), umgibt den Inhalt mit zwei horizontalen Linien:
das wäre so etwas:
HINWEIS
Es funktioniert mit allen Markdown-Varianten (die folgende leere Zeile ist wichtig).
Das Gute ist, dass Sie sich keine Gedanken darüber machen müssen, welche Markdown-Variante unterstützt wird oder welche Erweiterung installiert oder aktiviert ist.
EDIT : Wie @ filups21 in den Kommentaren erwähnt hat, scheint es, dass eine horizontale Linie
***
in RMarkdown dargestellt wird. Die zuvor erwähnte Lösung funktioniert also nicht mit allen Markdown-Geschmacksrichtungen, wie ursprünglich behauptet wurde.quelle
***
geht eine leere Linie voraus. Alternativ können Sie die Notiz in ein Blockzitat einfügen, indem Sie die Zeile mit beginnen>
(auch mit einer Leerzeile vorangestellt).Bei GitHub füge ich normalerweise ein Blockquote ein.
wird...
Natürlich gibt es immer einfaches HTML ...
quelle
> ℹ️ This is an information
oder> ⚠️ This is a warning
.Die einfachste Lösung, die ich für genau dasselbe Problem gefunden habe, besteht darin, eine mehrzeilige Tabelle mit einer Zeile und ohne Überschrift zu verwenden (in der ersten Spalte befindet sich ein Bild und in der zweiten ein Text):
Ein anderer Ansatz, der möglicherweise funktioniert (für PDF), ist die Verwendung der Latex-Standard- fbox- Direktive:
Oder das FancyBox-Modul für erweiterte Funktionen (und besser aussehende Boxen): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox .
quelle
Verwenden Sie die Ermahnungserweiterung . Für mkdocs kann es in der
mkdocs.yml
Datei konfiguriert werden:Fügen Sie dann die Notiz wie folgt in Ihre MD-Dateien ein:
Sehen Sie ein Beispiel hier .
quelle
Ähnlich wie bei der Lösung von Etienne lässt sich eine einfache Tabelle gut formatieren:
Eine andere Alternative (die stärker betont wird) besteht darin, den Inhalt zum Header einer Tabelle ohne Körper zu machen:
Schließlich können Sie eine horizontale Linie (thematische Unterbrechung) einfügen, um ein geschlossenes Feld zu erstellen (obwohl sich der Linienstil ein wenig von der Kopfzeile in der Tabelle unterscheidet):
Beachten Sie die leere Zeile nach dem Text.
quelle
NOTE
Spalte " " und 50% für die andere Spalte zuzuweisen . Man kann mehrzeilige Tabellen gemäß stackoverflow.com/questions/27219629 verwenden - aber dann gibt es andere Formatierungsprobleme.Hier ist ein einfaches Beispiel auf Latexbasis.
was in ... endet:
Da es sich um Latex handelt, können Sie leider keinen Markdown mehr in die TODO-Box einfügen (was normalerweise kein großes Problem darstellt), und es funktioniert nicht, wenn Sie in andere Formate als PDF (z. B. HTML) konvertieren.
quelle
Die folgenden Methoden funktionieren auf GitHub, auf GitLab ... und auf Stackoverflow , das jetzt CommonMark verwendet !
> Einzeilige Box mit Blockquote
`One-Line Box mit Backticks`
One-Line Box made with Backticks
`` `
Box mit Triple Backticks`
``
~ ~ ~
Box mit dreifachen Tilden (entfernen Sie die Zwischenräume zwischen den Tilden, damit dies funktioniert)
~ ~ ~
Box mit vier Leerzeichen am Anfang jeder Zeile:
... oder horizontale Linien verwenden?
Drei Striche (---) bilden eine horizontale Linie:
Hinweis : „Ihr Fokus bestimmt Ihre Realität.“ - Qui-Gon Jinn.
Für weitere Konfigurationen empfehle ich dringend das ausgezeichnete GitLab Markdown-Handbuch .
Sie können auch die weniger detaillierte GitHub-Grundformatierungssyntax überprüfen .
Sie können Markdown-Implementierungen mit Babelmark vergleichen .
Nützliche Hinweise:
Um eine neue Zeile zu erzwingen, setzen Sie zwei Leerzeichen am Ende der Zeile.
Verwenden Sie \, um Sonderzeichen zu vermeiden.
quelle
Haben Sie versucht, doppelte Tabulatoren zu verwenden? So machen Sie eine Box:
Es funktioniert für mich in einem regulären Rmarkdown-Dokument mit HTML-Ausgabe. Der Bereich mit zwei Registerkarten sollte in einem abgerundeten rechteckigen hellgrauen Feld angezeigt werden.
quelle
Sie können auch https://www.npmjs.com/package/markdown-it-container verwenden
Wird dann rendern als:
quelle