Kramdown tez, sof Ruby Markdown-superset konvertori

Sarlavhalar

kramdown Setext uslubi va atx uslubi sarlavhalarini qo'llab-quvvatlaydi. Ikkala shakl ham bitta hujjat ichida ishlatilishi mumkin.

Matn uslubi

Setext uslubidagi sarlavhalar blok chegarasida matn qatori (sarlavha matni) va faqat teng belgilar (birinchi darajali sarlavha uchun) yoki tire (ikkinchi darajali sarlavha uchun) bo'lgan chiziq bilan boshlanishi kerak . Sarlavha matni uchta bo'shliqqa qadar chekinishi mumkin, lekin har qanday bosh yoki keyingi bo'shliqlar sarlavha matnidan olib tashlanadi. Teng belgilar yoki chiziqlar miqdori unchalik ahamiyatli emas, faqat bittasi kifoya qiladi, lekin ko'proq ko'rinishi mumkin. Teng belgilar yoki chiziqlar birinchi ustundan boshlanishi kerak. Masalan:

First level header ==================

Second level header ------

Other first level header =


Setext sarlavhalari blok chegaralarida boshlanganligi sababli, bu ko'p hollarda ular oldida bo'sh qator bo'lishi kerakligini anglatadi. Biroq, Setext sarlavhasidan keyin bo'sh satrlar kerak emas:

This is a normal paragraph.

And A Header ------------
And a paragraph

> This is a blockquote.

And A Header ------------

https://kramdown.gettalong.org/syntax.html 5/30
07.05.2023, 19:53 Sintaksis | Kramdown
Biroq, odatda, Setext sarlavhasidan keyin bo'sh qatorni qo'llash yaxshi fikrdir, chunki u yanada mosroq ko'rinadi va hujjatni o'qishni osonlashtiradi.


Asl Markdown sintaksisi Setext sarlavhasi oldidan bo'sh qatorni tashlab qo'yish imkonini beradi. Biroq, bu noaniqliklarga olib keladi va hujjatni o'qishni kerak bo'lgandan ko'ra qiyinlashtiradi. Shuning uchun kramdown hujjatida bunga ruxsat berilmaydi.


Ta'kidlash joizki, bir chekka holat quyidagilardir:

header ---para

Bu gorizontal qoida yoki ikkinchi darajali sarlavha va paragraf bilan ajratilgan ikkita paragrafni ifodalaydimi, degan savol tug'ilishi mumkin . Misoldagi so'zlar bilan taklif qilinganidek, ikkinchisi shunday. Umumiy qoida shundaki, Setext sarlavhalari gorizontal qoidalardan oldin qayta ishlanadi.

atx uslubi

atx uslubidagi sarlavhalar blok chegarasida bir yoki bir nechta xesh belgilarni o'z ichiga olgan chiziqdan va keyin sarlavha matnidan boshlanishi kerak . Xesh belgilaridan oldin bo'sh joylarga ruxsat berilmaydi. Xesh-belgilar soni sarlavha darajasini belgilaydi: bitta xesh-belgi sizga birinchi darajali sarlavhani, ikkita ikkinchi darajali sarlavhani va hokazolar oltinchi darajali sarlavha uchun maksimal oltita xesh-belgiga qadar davom etadi. Sarlavhani yopish uchun ixtiyoriy ravishda satr oxiridagi istalgan sonli xeshlardan foydalanishingiz mumkin. Har qanday oldingi yoki keyingi bo'shliqlar sarlavha matnidan olib tashlanadi. Masalan:

# First level header

### Third level header ###

## Second level header ######

Shunga qaramay, asl Markdown sintaksisi atx uslubidagi sarlavha oldidan bo'sh qatorni qoldirib ketishga imkon beradi.

Sarlavha identifikatorini belgilash

kramdown PHP Markdown Extra va Maruku dan olingan sarlavha identifikatorini aniq belgilashning yaxshi usulini qo'llab-quvvatlaydi : Agar sarlavha matniga ochiladigan jingalak qavs (matndan kamida bitta bo'sh joy bilan ajratilgan), xesh, ID va yopilgan jingalak qavs, identifikator sarlavhada o'rnatiladi. Agar siz atx uslubidagi sarlavhalarning keyingi xesh xususiyatidan foydalansangiz, sarlavha identifikatori keyingi xeshlardan keyin ketishi kerak. Masalan:

Hello {#id} -----

# Hello {#id}

# Hello # {#id}

Ushbu qo'shimcha sintaksis standart Markdownning bir qismi emas.

Blok tirnoq

>Blok iqtibos markerdan so'ng ixtiyoriy bo'sh joy va blok tirnoq mazmuni yordamida boshlanadi . Markerning o'zi uchta bo'shliqqa qadar chekinishi mumkin. Barcha keyingi satrlar, ular blok-tirnoq belgisi bilan boshlanganmi yoki shunchaki matndan iborat bo‘ladimi, blok-tirnoqga tegishli, chunki blok qo‘shtirnoqlar qatorni o‘rashni qo‘llab-quvvatlaydi .

https://kramdown.gettalong.org/syntax.html 6/30
07.05.2023, 19:53 Sintaksis | Kramdown
Blok tirnoqning mazmuni blok darajasidagi elementlardir. Bu shuni anglatadiki, agar siz faqat matndan tarkib sifatida foydalansangiz, u xatboshiga o'raladi. Masalan, quyida sizga ikkita paragrafdan iborat bitta blok-iqtibos beriladi:

> This is a blockquote. > on multiple lines that may be lazy.
>
> This is the second paragraph.

Blok qo'shtirnoq tarkibi blok darajasidagi elementlar bo'lgani uchun siz blok-tirnoqlarni joylashtirishingiz va boshqa blok-darajali elementlardan foydalanishingiz mumkin (shuning uchun ham blok qo'shtirnoqlar qatorni o'rashni qo'llab-quvvatlashi kerak):

> This is a paragraph. >
> > A nested blockquote. >
> ## Headers work >
> * lists too >
> and all other block-level elements

E'tibor bering , blok-tirnoq ichidagi blok darajasidagi elementlarning chekinishi uchun bo'shliqlarni hisoblashda >markerdan keyingi birinchi bo'sh joy hisoblanmaydi ! Shunday qilib, kod bloklari beshta bo'shliq yoki bitta bo'sh joy va bitta yorliq bilan kiritilishi kerak, masalan:

> A code block: >
> ruby -e 'puts :works'

Chiziqlarni o'rash dangasa bo'lishga imkon beradi, lekin o'qishga to'sqinlik qiladi va shuning uchun, ayniqsa blok tirnoqlari bilan undan qochish kerak. Bu erda qatorni o'rash bilan blok tirnoqlardan foydalanishga misol:

> This is a paragraph inside a blockquote.
>
> > This is a nested paragraph that continues here
> and here
> > and here

Kod bloklari

Kod bloklari belgilash, HTML yoki dastur fragmenti kabi so'zma-so'z matnni ifodalash uchun ishlatilishi mumkin, chunki kod blokida sintaksis ajratilmaydi.