2014-09-03 10 views
16

Sto scrivendo un documento in markdown. Sto usando il meraviglioso pandoc per creare file docx e tex dal sorgente markdown. Mi piacerebbe avere una casella di testo per suggerimenti e note per i lettori il modo in cui i libri di programmazione spesso fanno. Non riesco a capire come farlo nel markdown. Puoi aiutare?Come posso creare una casella di testo per una nota in markdown?

risposta

12

Cosa faccio di solito per mettere finestra di avviso (ad esempio, nota o avviso) nei testi di riduzione dei prezzi (non solo quando si utilizza Pandoc ma anche ogni dove è sostenuto che Markdown) è che circonda il contenuto con due linee orizzontali:

--- 
**NOTE** 

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

--- 

che sarebbe qualcosa di simile:


NOTA

funziona wi tutti gli aromi di markdown (la riga vuota sottostante è importante).


La cosa buona è che non è necessario preoccuparsi di quale aroma di markdown è supportato o quale estensione è installata o abilitata.

+1

Questo è utile, ma non funziona con RMarkdown/Rstduio/Knitr – bjw

8

La soluzione più semplice che ho trovato per lo stesso problema è quello di utilizzare una tabella linea multipla con una riga e nessuna intestazione (c'è un'immagine nella prima colonna e il testo nella seconda):

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

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

Un altro approccio che potrebbe funzionare (per PDF) è quello di utilizzare di default in lattice fbox direttiva:

\fbox{My text!} 

o modulo Fancybox per le funzionalità più avanzate (e scatole più bello): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox.

+1

Sapete se è possibile definire come apparirà la nota di pandoc markdown all'interno del file di modello pandoc? Ad esempio, modificando ~/.pandoc/templates/default.latex? – tmaric

6

Utilizzare l'estensione admonition. Per mkdocs, può essere configurato nel file mkdocs.yml:

markdown_extensions: 
    - admonition 

quindi inserire la nota nei file md come segue:

!!! note 

    This is a note. 

vedere un esempio here.

3

Con GitHub, di solito inserisco un blockquote

NOTA: La nota soddisfare.

Naturalmente, c'è sempre il codice HTML semplice ...

+0

@KamilSJaron: eh? No, non lo sono. Stai pensando ai blocchi di codice? – naught101

+0

@ naught101 Ah, stavo leggendo blockquote come backquote. Tuttavia, le triple virgolette non sono, in effetti, avvolgenti. –

0

Ecco un semplice esempio a base di lattice.

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

che si traduce in: enter image description here

Purtroppo, perché questo è il lattice, si può non più includono mark-down all'interno della scatola TODO (che non è un problema enorme, di solito), e non sarà lavoro quando si converte in formati diversi da PDF (ad esempio html).

Problemi correlati