Ich schreibe ein Dokument in Markdown. Ich verwende das wunderbare Pandoc, um docx- und tex-Dateien aus der Markdown-Quelle zu erstellen. Ich hätte gern eine Textbox für Tipps und Notizen für die Leser, so wie Programmierbücher es oft tun. Ich kann nicht herausfinden, wie man das in Markdown macht. Kannst du helfen?Wie kann ich ein Textfeld für eine Notiz in Markdown erstellen?
Antwort
Was ich in der Regel für die Umsetzung Warnfeld (zB Hinweises oder eine Warnung) in Abschlags Texten (nicht nur, wenn pandoc mit, sondern auch allenthalben, dass Abschlag unterstützt wird), um den Inhalt mit zwei horizontalen Linien umgeben:
---
**NOTE**
It works with almost all markdown flavours (the below blank line matters).
---
denen würde so etwas wie dieses:
HINWEIS
Es wi funktioniert th alle Abschriften Aromen (die untere Leerzeile zählt).
Die gute Sache ist, dass Sie sich keine Sorgen machen müssen, welcher Markdown-Flavour unterstützt wird oder welche Erweiterung installiert oder aktiviert ist.
Die einfachste Lösung, die ich auf das exakt gleiche Problem gefunden habe, ist eine mehrzeilige Tabelle mit einer Zeile und keinen Header zu verwenden (es ist ein Bild in der ersten Spalte und der Text in den zweiten):
----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
bla bla bla bla bla bla bla ... the
blank line below is important
----------------------------------------------------------------
Ein weiterer Ansatz, der (für PDF) funktionieren könnte ist Latex Standard fbox Direktive zu verwenden:
für erweiterte Funktionen\fbox{My text!}
Oder FancyBox Modul (und besser aussehende Boxen): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox.
Wissen Sie, ob es möglich ist zu definieren, wie die Pandora-Markdown-Notiz in der Pandora-Vorlagendatei aussehen wird? Zum Beispiel Bearbeiten von ~/.pandoc/templates/default.latex? – tmaric
Verwenden Sie die admonition Erweiterung. Für mkdocs, kann es in der mkdocs.yml
Datei konfiguriert werden:
markdown_extensions:
- admonition
Dann die Notiz in der md-Dateien einfügen wie folgt:
!!! note
This is a note.
here ein Beispiel.
Sie können auch https://www.npmjs.com/package/markdown-it-container verwenden
::: warning
*here be dragons*
:::
Wird dann machen, wie:
<div class="warning">
<em>here be dragons</em>
</div>
Mit GitHub, füge ich in der Regel ein Zitat
HINWEIS: Die Notiz Inhalt.
Natürlich gibt es immer einfache HTML ...
@KamilSJaron: eh? Nein, sind sie nicht. Denkst du an Codeblöcke? – naught101
@ naught101 Ah, ich habe blockquote als backquote gelesen. Dreifache Backquotes sind jedoch nicht umhüllt. –
Hier ist ein einfaches Beispiel Latex-Basis.
---
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
Leider weil dieser Latex ist, können Sie nicht-mehr enthalten Abschlags in der TODO-Box (das kein großes Problem ist, in der Regel), und es wird nicht funktionieren bei der Konvertierung in andere Formate als PDF (zB HTML).
Dies ist nützlich, aber es funktioniert nicht mit RMarkdown/Rstduio/Knitr – bjw