Piszę dokument w przecenie. Używam wspaniałego pandoc do tworzenia plików docx i tex ze źródła Markdown. Chciałbym mieć pole tekstowe na wskazówki i uwagi dla czytelników, tak jak często robią to książki o programowaniu. Nie mogę wymyślić, jak to zrobić w ramach przeceny. Możesz pomóc?
86
Odpowiedzi:
To, co zwykle robię, aby umieścić pole ostrzegawcze (np. Uwaga lub Ostrzeżenie) w tekstach przecen (nie tylko podczas używania pandoc, ale także wszędzie tam, gdzie ta przecena jest obsługiwana), to otaczanie treści dwoma poziomymi liniami:
co wyglądałoby mniej więcej tak:
UWAGA
Działa ze wszystkimi smakami przecen (poniższy pusty wiersz ma znaczenie).
Dobrą rzeczą jest to, że nie musisz się martwić o to, który wariant przeceny jest obsługiwany lub które rozszerzenie jest zainstalowane lub włączone.
EDYCJA : Jak @ filups21 wspomniał w komentarzach, wydaje się, że pozioma linia jest reprezentowana przez
***
w RMarkdown. Tak więc rozwiązanie wspomniane wcześniej nie działa ze wszystkimi smakami przecen, jak pierwotnie twierdzono.źródło
***
poprzedzona pustą linią. Alternatywnie możesz umieścić notatkę w cytacie blokowym, rozpoczynając wiersz od>
(również poprzedzony pustą linią).W przypadku GitHub zwykle wstawiam cytat blokowy.
staje się...
Oczywiście zawsze jest zwykły HTML ...
źródło
> ℹ️ This is an information
lub> ⚠️ This is a warning
.Najprostszym rozwiązaniem tego samego problemu, które znalazłem, jest użycie tabeli wielowierszowej z jednym wierszem i bez nagłówka (w pierwszej kolumnie znajduje się obraz, a w drugiej tekst):
Innym podejściem, które może zadziałać (dla PDF) jest użycie domyślnej dyrektywy Latex fbox :
Lub moduł FancyBox dla bardziej zaawansowanych funkcji (i lepiej wyglądających pudełek): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox .
źródło
Użyj rozszerzenia upomnienia . W przypadku mkdocs można to skonfigurować w
mkdocs.yml
pliku:Następnie wstaw notatkę do plików md w następujący sposób:
Zobacz przykład tutaj .
źródło
Podobnie jak w rozwiązaniu Etienne, prosty stół ładnie formatuje:
Inną alternatywą (na którą kładzie się większy nacisk) jest umieszczenie treści jako nagłówka tabeli bez treści:
Na koniec możesz dołączyć linię poziomą (podział tematyczny), aby utworzyć zamkniętą ramkę (chociaż styl linii różni się nieco od linii nagłówka w tabeli):
Zwróć uwagę na pusty wiersz po tekście.
źródło
NOTE
kolumnę „ ” i 50% na drugą; można używać tabel wielowierszowych zgodnie ze stackoverflow.com/questions/27219629 - ale są też inne problemy z formatowaniem.Oto prosty przykład oparty na lateksie.
Co skutkuje w:
Niestety, ponieważ jest to lateks, nie można już umieszczać przecen w polu TODO (co zwykle nie jest dużym problemem) i nie zadziała przy konwersji do formatów innych niż PDF (np. Html).
źródło
Następujące metody działają na GitHub, na GitLab ... i na Stackoverflow , który teraz używa CommonMark !
> Jednowierszowe pudełko wykonane za pomocą Blockquote
`One-Line Box wykonane z Backticks`
One-Line Box made with Backticks
``
Pudełko wykonane z potrójnymi znakami wstecznymi
''
~ ~ ~
Pudełko wykonane z Potrójnych Tild (usuń spacje między tyldami, aby to zadziałało)
~ ~ ~
Pudełko wykonane z czterema spacjami na początku każdej linii:
... lub użyj linii poziomych?
Trzy kreski (---) tworzą poziomą linię:
Uwaga : „Twoje skupienie określa Twoją rzeczywistość”. - Qui-Gon Jinn.
Aby uzyskać więcej konfiguracji, zdecydowanie polecam doskonały przewodnik po GitLab Markdown .
Możesz również sprawdzić mniej szczegółową podstawową składnię formatowania GitHub .
Możesz porównać implementacje Markdown za pomocą Babelmark .
Przydatne wskazówki:
aby wymusić nowy wiersz, wstaw dwie spacje na końcu linii;
aby uniknąć znaków specjalnych, użyj \.
źródło
Czy próbowałeś używać podwójnych zakładek? Aby zrobić pudełko:
U mnie działa w zwykłym dokumencie Rmarkdown z wyjściem html. Część z podwójnymi zakładkami powinna pojawić się w zaokrąglonym prostokątnym, jasnoszarym polu.
źródło
Możesz również użyć https://www.npmjs.com/package/markdown-it-container
Następnie wyrenderuje się jako:
źródło