Bevezetés a Markdownba

Árleszállítás

A Markdown egy szövegből HTML átalakító eszköz. Ma már a könnyű jelölő leíró nyelvek osztályának de facto szinonimája lett. Egyszerű szöveges formázási szintaxist használ. A Markdown ötlete az volt, hogy a weboldalak és különösen a blogbejegyzések írása ugyanolyan egyszerű legyen, mint az e-mail írása. 2017 novemberében a célt elérték, és a Markdown, valamint az Asciidoc, Asciidoctor és Asciidoctor-pdf származékok széles körben vannak használatban.

A Markdown csak a sima szövegre összpontosít, és tartózkodik a HTML-ben található összes egyéb összetettségtől. Könnyen megtanulható, mivel egyszerűvé válik, ezért gyorsabb is, mivel minimális karaktereket használnak, ami végül kevesebb hibalehetőséghez vezet. A Markdown szerkesztő Stackeditben bemutatott alapdokumentumát lásd az 1. ábrán. A bal oldalon a forráskód, a jobb oldalon a megfelelő HTML kimenet látható. Észreveheti, hogy a címsorokat egyszerűen # számokkal jelölik a címsor hierarchia szintjének megfelelően.

Szövegkonverzió

Az egyszerű szöveg átalakítható XHTML-re (HTML) és sok más formátumra a parancssori eszközök, például a Markdown vagy a Pandoc segítségével. Alapvetően mindkét eszköz csak HTML-töredékeket hoz létre, és a kimenetet az stdout-ba írja. A Pandoc felajánlja az „-o fájlnév” kapcsolót, hogy a HTML kimenetet az adott fájlba írja. Amint az alább látható, a kimeneti fájl neve Basic.html és tartalmazza a HTML töredéket - két címsort és egy bekezdést.

$ pandoc -o alap.html basic.md $ cat basic.html 
Debian csomagkészítés útmutató
 
Előszó
 A gép felelőssége azt jelenti, hogy gondoskodni kell a hardverről és a szoftver alkatrészeiről. Amint azt a mindennapi életben rendszergazdaként látjuk, sokkal jobb, ha szoftvereket telepítünk szoftvercsomagként, nem pedig sok forrásfájlt. Ez csökkenti a rendszer megfelelő karbantartásának költségeit. $ 

Önálló HTML dokumentumok létrehozásához teljes HTML fejléccel a Pandoc a következőképpen fogadja el az „-s” kapcsolót:

$ pandoc -o alap.html -s alap.md $ cat basic.html           
Debian csomagkészítés útmutató
 
Előszó
 A gép felelőssége azt jelenti, hogy gondoskodni kell a hardverről és a szoftver alkatrészeiről. Amint azt a mindennapi élet rendszergazdaként látja, sokkal jobb, ha a szoftvereket szoftvercsomagként telepíti, nem pedig egy csomó forrásfájlt. Ez csökkenti a rendszer megfelelő karbantartásának költségeit.   

A tartalom és a vizuális megjelenítés elkülönítésének előnye, hogy nem fogja elrontani a webhely megjelenését. 1. verzió.0.1, amelyet John Gruber és Aaron Swartz fejlesztett ki, 2004 decemberében jelent meg és ingyenes szoftverként érhető el (lásd a cikk végén található linkeket).

Szöveges elemek

Címsorok

A megfelelő HTML-szintnek megfelelően a címsorokat # -szel írjuk az alábbiak szerint:

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

H1 és H2 esetében két alternatív írásmódot fogadnak el:

H1 == H2 -- 

Felhívjuk figyelmét, hogy az egyenlőségjelek vagy kötőjelek számának meg kell egyeznie a címsor karaktereinek számával.

A szöveg hangsúlyozása

A szöveg hangsúlyozása érdekében ezeket az elemeket támogatjuk:

• dőlt betű: egyetlen csillag vagy egyetlen aláhúzás
  --
  * fontos * és _is fontos_
  --
• félkövér szöveg: kettős csillag vagy kettős aláhúzás
  --
  ** fontos ** és __is fontos__
  --
• áthúzott szöveg: kettős tilde
  --
  ~~ szöveg ~~
  --

Listák

A Markdown támogatja a nem rendezett és rendezett listákat. A rendezett listák csillaggal, plusz vagy mínusz jellel kezdődnek. A rendezett listák csak egy számjeggyel kezdődnek. Allisták létrehozásához a szóköz behúzza két szóközzel (Markdown, StackEdit) vagy négy szóközzel (Pandoc) az alábbiak szerint:

1. gyümölcsök * alma * banán 2. italok + víz + tej 

Képek

A legegyszerűbb módszer az inline stílus használata az alábbiak szerint:

![A Debian logó] (debian logó.png „Debian logó”) 

Ez megjeleníti a hivatkozott képet. Amint az egérmutatót a kép fölé viszi, megjelenik a megfelelő leíró szöveg.

Kód és szintaxis kiemelés

Két változat létezik - belső kód és kódblokkok. A soron belüli kód három backtick-ben van kialakítva, mint például a „'print” („Hello, világ!!”)„ ”. A kódblokkok szintén három backtick-el kezdődnek és végződnek, de külön sorokban az alábbiak szerint:

"print (" Helló, világ!”)”

A Markdown nem támogatja a szintaxis kiemelését, de a dialektusokhoz hasonló dialektusok itt vannak.

Táblázatok

A Markdown nem támogatja a táblázatokat, de olyan kiterjesztéseket, mint a GFM és a Markdown Here.

Blokk idézetek

A blokk idézetek csak „>” jellel kezdődnek. Elég praktikus lesz szöveget idézni.

> "Ó! abszurd egy kemény és gyors szabály arról, hogy mit kell> olvasni és mit nem. A modern kultúra több mint fele attól függ,> mit nem szabad olvasni.">> A keresettség fontossága. (Oscar Wilde) 

Linkek

A linkek más dokumentumokra vagy az aktuális szakaszaira utalnak. Az írási stílus hasonló a képekhez, és a szögletes zárójelben lévő linkleírásból, a szabályos zárójelben lévő URL-ből áll.

[Inline stílusú link vagyok] (https: // linuxhint.com) 

Ezenkívül felvehet egy alternatív szöveget:

[Inline stílusú link vagyok további szöveggel] (https: // linuxhint.com “LinuxHint”) 

A linkekre a következőképpen lehet hivatkozni:

[LinuxHint] [1] ... néhány szöveg ... [1]: https: // linuxhint.com 

Ez lehetővé teszi, hogy könnyen összeállítsa a hivatkozások listáját a dokumentum végén, mivel ez a tudományos dokumentumokban szokásos.

Következtetés

A Markdown nagyon egyszerű, és mindenkinek kötelező, aki dokumentációt készít és rendszeresen publikál tartalmat. Nagy öröm használni.

Hivatkozások

• StackEdit, https: // stackedit.io / szerkesztő
• Pandoc, http: // pandoc.org /
• Markdown, https: // merész tűzlabda.nettó / projektek / árrés /
• Markdown Cheatsheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet