Jak utworzyć pole tekstowe dla notatki w przecenie?

Question

Piszę dokument w przecenie. Używam wspaniałego pandoc do tworzenia plików docx i tex ze źródła przecen. Chciałbym mieć pole tekstowe dla wskazówek i notatek dla czytelników, tak jak często robią książki z programowania. Nie mogę wymyślić, jak to zrobić w przecenie. Możesz pomóc?

Answer 1

Co zwykle zrobić, aby otrzymywać powiadomienia pole wprowadzenie (np notatka lub ostrzeżenie) w tekstach przecen (nie tylko podczas korzystania pandoc ale również wszędzie że Przecena jest obsługiwany) otacza zawartość z dwóch linii poziomych:

--- 
**NOTE** 

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

--- 

co byłoby coś takiego:

---

UWAGA

działa wi wszystkie smaki marki (poniżej liczy się pusta linia).

---

Dobrą rzeczą jest to, że nie trzeba się martwić o których Przecena smak jest obsługiwany lub których rozszerzenie jest zainstalowany lub włączone.

Answer 2

Najprostszym rozwiązaniem, jakie stwierdzono, że dokładnie ten sam problem jest użycie wielu stół liniowy z jednym rzędem i bez nagłówka (jest to obraz w pierwszej kolumnie i tekst w drugim)

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

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

Innym podejściem, które mogą pracować (dla PDF) jest użyć domyślnego lateks fBOX dyrektywa:

\fbox{My text!} 

lub moduł fancybox dla bardziej zaawansowanych funkcji (i skrzynek lepiej patrząc): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox.

Answer 3

Użyj rozszerzenia admonition. Dla mkdocs, może być skonfigurowany w pliku mkdocs.yml:

markdown_extensions: 
    - admonition 

Następnie wstawić notatkę w swoim md plików w następujący sposób:

!!! note 

    This is a note. 

Zobacz przykład here.

Answer 4

Można również użyć https://www.npmjs.com/package/markdown-it-container

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

następnie renderowanie jak:

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

Answer 5

Z GitHub, zazwyczaj wstawić blockquote

UWAGA: Nota zadowolony.

Oczywiście, zawsze jest zwykły HTML ...

Answer 6

Oto prosty przykład lateks oparte.

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

co skutkuje:

Niestety, ponieważ jest to lateks, można bez zawierają już przecen wewnątrz pudełka TODO (co nie jest wielkim problemem, zazwyczaj), a to nie będzie działa podczas konwersji do formatów innych niż PDF (np. html).