Úvod do Markdownu

Markdown

Markdown je nástroj na prevod textu do HTML. Dnes sa stalo de facto synonymom pre triedu ľahkých jazykov popisu značiek. Používa syntax formátovania obyčajného textu. Myšlienkou spoločnosti Markdown bolo, aby písanie webových stránok a hlavne blogových záznamov bolo také ľahké ako písanie e-mailov. V novembri 2017 je cieľ splnený a Markdown, ako aj jeho derivácie Asciidoc, Asciidoctor a Asciidoctor-pdf sa často používajú.

Markdown sa zameriava iba na obyčajný text a zdrží sa všetkých ostatných zložitostí, ktoré sa vyskytujú v HTML. Je ľahké sa ho naučiť, pretože je jednoduchý, a preto aj rýchlejší, pretože sa používa minimum znakov, čo nakoniec vedie k menšej pravdepodobnosti chyby. Na obrázku 1 je základný dokument zobrazený v editore Markdown Stackedit. Na ľavej strane vidíte zdrojový kód a na pravej strane príslušný výstup HTML. Môžete si všimnúť, že nadpisy sú jednoducho označené číslom # podľa úrovne hierarchie nadpisu.

Konverzia textu

Prostý text je možné previesť na XHTML (HTML) a na mnoho ďalších formátov pomocou nástrojov príkazového riadku, ako sú Markdown alebo Pandoc. Oba nástroje v zásade vytvárajú iba fragmenty HTML a výstup zapisujú na štandardný výstup. Pandoc ponúka prepínač „-o názov súboru“ na zápis výstupu HTML do daného súboru. Ako je vidieť nižšie, výstupný súbor má názov basic.html a obsahuje fragment HTML - dva nadpisy a odsek.

$ pandoc -o základné.html základný.md $ mačka základná.html 
Príručka na vytváranie balíkov Debian
 
Predslov
 Zodpovednosť za stroj znamená starostlivosť o hardvér aj softvérové ​​komponenty. Ako je to v každodennom živote vidieť ako správca systému, je oveľa lepšie inštalovať softvér ako softvérový balík než ako hromadu zdrojových súborov. To znižuje náklady na správnu údržbu systému. $ 

Ak chcete vytvoriť samostatné dokumenty HTML s úplnou hlavičkou HTML, Pandoc akceptuje prepínač „-s“ nasledovne:

$ pandoc -o základné.html -s basic.md $ mačka základná.html           
Príručka na vytváranie balíkov Debian
 
Predslov
 Zodpovednosť za stroj znamená starostlivosť o hardvér aj softvérové ​​komponenty. Ako je to v každodennom živote vidieť ako správca systému, je oveľa lepšie inštalovať softvér ako softvérový balík ako ako hromadu zdrojových súborov. To znižuje náklady na správnu údržbu systému.   

Výhodou oddeleného obsahu od vizuálneho zobrazenia je, že nezkazí vzhľad vášho webu. Verzia 1.0.1, ktorý vyvinuli John Gruber a Aaron Swartz, bol vydaný v decembri 2004 a je k dispozícii ako slobodný softvér (pozri odkazy na konci tohto článku).

Textové prvky

Nadpisy

Podľa príslušnej úrovne HTML sú nadpisy napísané nasledujúcim počtom #:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

Pre H1 a H2 sú akceptované dva alternatívne spôsoby zápisu:

H1 == H2 -- 

Počet rovnakých znakov alebo pomlčiek musí zodpovedať počtu znakov nadpisu.

Zdôraznenie textu

S cieľom zdôrazniť text sú podporované tieto prvky:

• kurzíva: jednotlivé hviezdičky alebo jednotlivé podčiarkovníky
  --
  * dôležité * a _ tiež dôležité_
  --
• tučný text: dvojité hviezdičky alebo dvojité podčiarknutia
  --
  ** dôležité ** a __tiež dôležité__
  --
• preškrtnutý text: dvojité tildes
  --
  ~~ text ~~
  --

Zoznamy

Markdown podporuje neusporiadané a zoradené zoznamy. Poradové zoznamy sa začínajú hviezdičkou, znamienkom plus alebo mínus. Poradové zoznamy sa začínajú iba číslicami. Ak chcete vytvoriť podlisty, odsaďte listitem o dve medzery (Markdown, StackEdit) alebo štyri medzery (Pandoc), ako vidíte nižšie:

1. ovocie * jablko * banán 2. nápoje + voda + mlieko 

snímky

Najjednoduchší spôsob je použiť vložený štýl nasledovne:

![Logo Debianu] (logo Debianu.png „Logo Debianu“) 

Zobrazí sa referenčný obrázok. Hneď ako prejdete kurzorom myši nad obrázok, uvidíte príslušný text popisu.

Zvýraznenie kódu a syntaxe

Existujú dva varianty - vložený kód a bloky kódu. Vložený kód je zarámovaný do troch spätných kliknutí, ako napríklad „„ print („Dobrý deň, svet!”)“ „. Bloky kódu tiež začínajú a končia tromi spätnými loptičkami, ale na samostatných riadkoch nasledovne:

"tlačiť („ Ahoj, svet!”)“

Markdown nepodporuje zvýrazňovanie syntaxe, ale dialekty ako Markdown Here áno.

Tabuľky

Markdown nepodporuje tabuľky, ale rozšírenia ako GFM a Markdown Here.

Blokové úvodzovky

Blokové úvodzovky začínajú iba znakom „>“. Je celkom užitočné citovať text.

> „Och! je absurdné mať tvrdé a rýchle pravidlo o tom, čo by si mal človek prečítať a čo by nemal. Viac ako polovica modernej kultúry závisí> od toho, čo by si človek nemal prečítať.">> Dôležitosť zárobku. (Oscar Wilde) 

Odkazy

Odkazy odkazujú na iné dokumenty alebo na sekcie v aktuálnom. Štýl písania je podobný obrázkom a pozostáva z popisu odkazu v hranatých zátvorkách a adresy URL v bežných zátvorkách.

[Som linkový odkaz] (https: // linuxhint.com) 

Ďalej môžete pridať alternatívny text:

[Som linkový odkaz s ďalším textom] (https: // linuxhint.com „LinuxHint“) 

Na odkazy je možné odkazovať takto:

[LinuxHint] [1] ... nejaký text ... [1]: https: // linuxhint.com 

Toto vám umožní ľahko zostaviť zoznamy odkazov na konci dokumentu, ako je to bežné vo vedeckých dokumentoch.

Záver

Markdown je dosť jednoduchý a musí byť nevyhnutnosťou pre každého, kto robí dokumentáciu a pravidelne publikuje obsah. Je veľké potešenie ho používať.

Referencie

• StackEdit, https: // stackedit.io / editor
• Pandoc, http: // pandoc.org /
• Markdown, https: // daringfireball.net / projects / markdown /
• Markdown Cheatheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet