kramdown - Online w chmurze

PROGRAM:

IMIĘ

kramdown - szybki konwerter supersetów Ruby Markdown

STRESZCZENIE

kramdown [Opcje] [FILE ...]

OPIS

kramdown jest używany głównie do analizowania nadzbioru Markdowna i konwertowania go na
różne formaty wyjściowe. Obsługuje standardowy Markdown (z niewielkimi modyfikacjami)
oraz różne rozszerzenia, takie jak tabele i listy definicji. Ze względu na swoją modułową architekturę
pozwala również na inne formaty wejściowe niż Markdown, na przykład HTML lub Github Flavored
Obniżka cen.

If FILE nie określono, kramdown czyta ze standardowego wejścia. Wynik jest zapisywany do
standardowe wyjście.

Kramdown akceptuje dwa zestawy opcji: Pierwszy z nich zawiera opcje
które są używane bezpośrednio przez binarny kramdown. Drugi zestaw opcji kontroluje sposób
kramdown analizuje i konwertuje dane wejściowe.

OPCJE

-ja, --Wejście ARG
Określ format wejściowy. Dostępne formaty wejściowe: kramdown (jest to ustawienie domyślne),
przeceny, GFM lub html.

-o, --wyjście ARG
Określ jeden lub więcej formatów wyjściowych oddzielonych przecinkami: html (domyślny), kramdown,
lateks, pdf lub remove_html_tags.

-v, --wersja
Pokaż wersję kramdown.

-H, --help
Pokaż pomoc.

KRAMW DÓŁ OPCJE

--auto-id-przedrostek ARG

Prefiks używany do automatycznie generowanych identyfikatorów nagłówka

Ta opcja może być użyta do ustawienia prefiksu dla automatycznie generowanych identyfikatorów nagłówka
aby nie było konfliktu podczas renderowania wielu dokumentów kramdown w jeden
plik wyjściowy osobno. Prefiks powinien zawierać tylko znaki, które są poprawne w
dowód tożsamości!

Domyślnie: '' Używany przez: konwerter HTML/Latex

--[nie-]automatyczne usuwanie identyfikatorów

Usuń całe formatowanie z tekstu nagłówka, aby automatycznie wygenerować identyfikator

Jeśli ta opcja ma wartość `true`, tylko elementy tekstowe nagłówka są używane do
generowanie identyfikatora później (w przeciwieństwie do korzystania z czystej linii tekstowej nagłówka).

Ta opcja zostanie usunięta w wersji 2.0, ponieważ wtedy będzie to ustawienie domyślne.

Domyślnie: false Używany przez: kramdown parser

--[nie-]automatyczne identyfikatory

Użyj automatycznego generowania identyfikatora nagłówka

Jeśli ta opcja ma wartość `true`, wartości identyfikatorów dla wszystkich nagłówków są generowane automatycznie, jeśli
nie określono jawnie identyfikatora.

Domyślnie: true Używany przez: konwerter HTML/Latex

--coderay-pogrubienie-każdy ARG

Określa, jak często numer linii powinien być pogrubiony

Może być liczbą całkowitą lub fałszem (aby całkowicie wyłączyć pogrubione liczby w wierszach).

Domyślnie: 10 Używany przez: konwerter HTML

--coderay-css ARG

Definiuje sposób stylizacji podświetlonego kodu

Możliwe wartości to :class (klasy CSS są stosowane do elementów kodu, należy
dostarczyć potrzebny plik CSS) lub :style (domyślne style CSS są stosowane bezpośrednio do
elementy kodu).

Domyślnie: styl Używany przez: konwerter HTML

--coderay-domyślny-język ARG

Ustawia domyślny język podświetlania bloków kodu

Jeśli żaden język nie jest ustawiony dla bloku kodu, zamiast tego używany jest język domyślny. ten
wartość musi być jednym z języków obsługiwanych przez coderay lub zero, jeśli nie ma wartości domyślnej
należy używać języka.

Domyślnie: zero Używany przez: konwerter HTML

--coderay-line-number-start ARG

Wartość początkowa numerów linii

Domyślnie: 1 Używany przez: konwerter HTML

--coderay-line-numbers ARG

Określa, jak i czy powinny być pokazywane numery linii

Możliwe wartości to :table, :inline lub zero. Jeśli ta opcja ma wartość zero, brak linii
wyświetlane są liczby.

Domyślnie: :inline Używany przez: konwerter HTML

--coderay-tabela-szerokość ARG

Szerokość tabulatora używana w podświetlonym kodzie

Używany przez: konwerter HTML

--coderay-wrap ARG

Określa, w jaki sposób podświetlony kod powinien być opakowany

Możliwe wartości to :span, :div lub nil.

Domyślnie: :div Używany przez: konwerter HTML

--[nie-]włącz kodowanie

Użyj coderay do podświetlania składni

Jeśli ta opcja ma wartość `true`, coderay jest używany przez konwerter HTML do składni
podświetlanie zawartości zakresów kodu i bloków kodu.

Domyślnie: true Używany przez: konwerter HTML

--jednostka-wyjście ARG

Definiuje sposób wyprowadzania jednostek

Możliwe wartości to :as_input (elementy są wyprowadzane w tej samej formie, co w
dane wejściowe), :numeric (elementy są wyprowadzane w postaci liczbowej), :symbolic (elementy są
wypisz w formie symbolicznej, jeśli to możliwe) lub :as_char (elementy są wyprowadzane jako znaki
jeśli to możliwe, dostępne tylko w Rubim 1.9).

Domyślnie: :as_char Używany przez: konwerter HTML, konwerter kramdown

--przypis-link zwrotny ARG

Definiuje tekst, który powinien być użyty w przypisach zwrotnych

Link zwrotny do przypisu to tylko tekst, więc wszelkie specjalne znaki HTML zostaną pominięte.

Jeśli tekst odnośnika do przypisu jest pustym ciągiem, nie będzie żadnych odnośników do przypisu
wygenerowane.

Domyślnie: '&8617;' Używany przez: konwerter HTML

--przypis-nr ARG

Numer pierwszego przypisu

Ta opcja może służyć do określenia numeru używanego w pierwszym przypisie.

Domyślnie: 1 Używany przez: konwerter HTML

--[nie-]hard-wrap

Interpretuje łamanie linii dosłownie

Wstaw kod HTML ` ` znaczniki wewnątrz akapitów, gdzie oryginalny dokument Markdown
miał nowe wiersze (domyślnie Markdown ignoruje te nowe wiersze).

Domyślnie: true Używany przez: parser GFM

--przesunięcie-nagłówka ARG

Ustawia offset wyjściowy dla nagłówków

Jeśli ta opcja ma wartość c (może być również ujemna), to nagłówek o poziomie n będzie
wyjście jako nagłówek o poziomie c+n. Jeśli c+n jest mniejsze niż 1, zostanie użyty poziom 1. Gdyby
c+n jest większe niż 6, zostanie użyty poziom 6.

Domyślnie: 0 Używany przez: konwerter HTML, konwerter Kramdown, konwerter Latex

--[no-]html-na-natywny

Konwertuj elementy HTML na elementy natywne

Jeśli ta opcja ma wartość „true”, parser konwertuje elementy HTML na elementy natywne. Do
na przykład, podczas parsowania ` hallo ` znacznik emfazy normalnie zostałby przekonwertowany
do elementu `:html` ze znacznikiem typu `:em`. Jeśli `html_to_native` ma wartość `true`, wtedy
wyróżnienie zostanie przekonwertowane na natywny element `:em`.

Jest to przydatne dla konwerterów, którzy nie potrafią poradzić sobie z elementami HTML.

Domyślnie: false Używany przez: kramdown parser

--lateks-nagłówki ARG

Definiuje polecenia LaTeX dla różnych poziomów nagłówka

Polecenia dla poziomów nagłówka od pierwszego do szóstego można określić, oddzielając je
z przecinkami.

Domyślnie: sekcja,podrozdział,podrozdział,akapit,podpunkt,podpunkt Używany
przez: konwerter lateksu

--szerokość linii ARG

Określa szerokość linii, która ma być używana podczas drukowania dokumentu

Domyślnie: 72 Używany przez: konwerter kramdown

--link-defs ARG

Wstępnie definiuje definicje linków

Ta opcja może służyć do wstępnego definiowania definicji łącza. Wartość musi być
Hash, w którym klucze to identyfikatory linków, a wartości to dwa elementy Tablice
z adresem URL linku i tytułem linku.

Jeśli wartość jest ciągiem, musi zawierać poprawny skrót YAML, a skrót musi
postępuj zgodnie z powyższymi wytycznymi.

Domyślnie: {} Używany przez: kramdown parser

--silnik matematyczny ARG

Ustaw silnik matematyczny

Określa silnik matematyczny, który powinien być używany do konwersji bloków/rozpiętości matematycznych. Gdyby
ta opcja jest ustawiona na +nil+, nie jest używany żaden silnik matematyczny, a bloki/zakresy matematyczne są
wyjście jak jest.

Opcje dla wybranego silnika matematycznego można ustawić za pomocą math_engine_opts
opcja konfiguracji.

Domyślnie: mathjax Używany przez: konwerter HTML

--opcje-matematyki-silnika ARG

Ustaw opcje silnika matematycznego

Określa opcje dla silnika matematycznego ustawionego za pomocą opcji konfiguracyjnej math_engine.

Wartość musi być hashem z parami klucz-wartość, które są rozumiane przez używane
silnik matematyczny.

Domyślnie: {} Używany przez: konwerter HTML

--[nie-]przeanalizuj-blok-html

Przetwarzaj składnię kramdown w blokowych tagach HTML

Jeśli ta opcja ma wartość `true`, parser kramdown przetwarza zawartość bloku HTML
znaczniki jako tekst zawierający elementy blokowe. Ponieważ nie jest to normalnie pożądane,
wartość domyślna to `false`. Zwykle lepiej jest selektywnie włączyć kramdown
przetwarzanie za pomocą atrybutu przeceny.

Domyślnie: false Używany przez: kramdown parser

--[nie-]parse-span-html

Przetwarzaj składnię kramdown w tagach span HTML

Jeśli ta opcja ma wartość `true`, parser kramdown przetwarza zawartość span HTML
znaczniki jako tekst zawierający elementy zakresu.

Domyślnie: true Używany przez: kramdown parser

--[no-]usuń-blokuj-tag-html

Usuń blokowe tagi HTML

Jeśli ta opcja ma wartość „true”, konwerter RemoveHtmlTags usuwa blokowe tagi HTML.

Domyślnie: true Używany przez: RemoveHtmlTags converter

--[nie-]usuń-span-html-tags

Usuń span tagi HTML

Jeśli ta opcja ma wartość „true”, konwerter RemoveHtmlTags usuwa znaczniki HTML span.

Domyślnie: false Używany przez: RemoveHtmlTags converter

--inteligentne-cytaty ARG

Definiuje nazwy encji HTML lub punkty kodowe dla wyjścia inteligentnego cytatu

Podmioty zidentyfikowane przez nazwę podmiotu lub punkt kodowy, których należy użyć, w:
kolejność, lewy pojedynczy cudzysłów, prawy pojedynczy cudzysłów, lewy podwójny i prawy podwójny
cytat są określane przez oddzielenie ich przecinkami.

Domyślnie: lsquo,rsquo,ldquo,rdquo Używany przez: konwerter HTML/Latex

--podświetlacz-składni ARG

Ustaw podświetlanie składni

Określa podświetlacz składni, który powinien być używany do podświetlania bloków kodu
i przęsła. Jeśli ta opcja jest ustawiona na +nil+, podświetlanie składni nie jest wykonywane.

Opcje podświetlania składni można ustawić za pomocą syntax_highlighter_opts
opcja konfiguracji.

Domyślnie: coderay Używany przez: konwerter HTML/Latex

--składnia-wyróżnienia-opts ARG

Ustaw opcje podświetlania składni

Określa opcje zestawu podświetlania składni za pomocą syntax_highlighter
opcja konfiguracji.

Wartość musi być hashem z parami klucz-wartość, które są rozumiane przez używane
wyróżnienie składni.

Domyślnie: {} Używany przez: konwerter HTML/Latex

--szablon ARG

Nazwa pliku szablonu ERB, który powinien być użyty do zawijania danych wyjściowych lub ERB
sam szablon.

Służy do pakowania danych wyjściowych w środowisko, dzięki czemu dane wyjściowe mogą być używane jako
samodzielny dokument. Na przykład szablon HTML zapewniłby potrzebne
tagi header i body, dzięki czemu całe wyjście jest prawidłowym plikiem HTML. Jeśli nie ma szablonu
jest określony, wynik będzie po prostu przekonwertowanym tekstem.

Podczas rozwiązywania pliku szablonu podana nazwa szablonu jest używana jako pierwsza. Jeśli takie...
plik nie został znaleziony, rozszerzenie konwertera (takie samo jak nazwa konwertera) to
dołączone. Jeśli nadal nie można znaleźć pliku, nazwa szablonu jest interpretowana jako
nazwa szablonu dostarczona przez kramdown (bez rozszerzenia konwertera). Gdyby
plik nadal nie został znaleziony, sprawdzana jest nazwa szablonu, jeśli zaczyna się od
„string://”, a jeśli tak, ten prefiks jest usuwany, a reszta jest używana jako szablon
treści.

kramdown zapewnia domyślny szablon o nazwie 'document' dla każdego konwertera.

Domyślnie: '' Używany przez: wszystkie konwertery

--poziomy-toc ARG

Definiuje poziomy używane w spisie treści

Poszczególne poziomy można określić oddzielając je przecinkami (np. 1,2,3)
lub używając składni zakresu (np. 1..3). Tylko określone poziomy są używane do
spis treści.

Domyślnie: 1..6 Używany przez: konwerter HTML/Latex

--[no-]transliterowane-nagłówki-id

Transliteruj tekst nagłówka przed wygenerowaniem identyfikatora

W identyfikatorach nagłówków używane są tylko znaki ASCII. To nie jest dobre dla języków z
wiele znaków spoza zestawu ASCII. Po włączeniu tej opcji tekst nagłówka jest
transliterowane do ASCII tak dobrze, jak to możliwe, aby wynikowy identyfikator nagłówka był większy
przydatny.

Aby ta funkcja działała, należy zainstalować bibliotekę stringex!

Domyślnie: false Używany przez: konwerter HTML/Latex

EXIT STATUS

Kod wyjścia to 0, jeśli nie wystąpił żaden błąd. W przeciwnym razie jest to 1.

Korzystaj z kramdown online za pomocą usług onworks.net