Markdown синтаксисі және оның құжаттамадағы рөлі
Markdown — мәтінді қарапайым әрі оқылатын түрде форматтауға мүмкіндік беретін жеңіл белгілеу тілі. Ол техникалық құжаттамаларды, README файлдарын, нұсқаулықтарды және қысқа мақалаларды дайындау үшін кеңінен қолданылады. Бұл формат мәтіннің құрылымын код деңгейінде анық көрсетіп, сонымен бірге оны көрнекі түрде стильдеуге мүмкіндік береді.
Бұл құралда Markdown синтаксисінің негізгі және кеңейтілген элементтеріне қолдау көрсетіледі:
- Тақырыптар: Құжаттың иерархиясын айқындайтын әртүрлі деңгейдегі тақырыптар.
- Тізімдер: Реттелген және реттелмеген тізімдер, сондай-ақ GitHub стиліндегі тапсырмалар тізімі (task lists).
- Кестелер мен код блоктары: Деректерді жүйелеуге және бағдарламалық код үзінділерін көрсетуге арналған құрылымдар.
- Дәйексөздер мен сілтемелер: Сыртқы дереккөздерге бағыттайтын белсенді сілтемелер мен ерекшеленген мәтін блоктары.
- Суреттер мен қаріп мәнерлері: Құжатқа графикалық элементтер енгізу және мәтінді қалың немесе көлбеу қаріппен ерекшелеу мүмкіндігі.
Браузерде өңдеу және құпиялылық артықшылықтары
Құжаттармен жұмыс істеу кезінде деректердің қауіпсіздігі мен өңдеу жылдамдығы маңызды рөл атқарады. Бұл құралда мәтінді талдау, алдын ала қарау және PDF форматына экспорттау процестерінің барлығы браузеріңізде жергілікті түрде орындалады.
Markdown мәтініңіз браузеріңізде өңделеді. BroBroGo серверіне ештеңе жүктелмейді. Мұндай клиенттік өңдеу (client-side processing) жүйенің жылдам жұмыс істеуін қамтамасыз етеді, өйткені деректерді сыртқы серверлерге жіберу және олардан жауап күту қажет болмайды. Барлық есептеулер пайдаланушының құрылғысында тікелей орындалады.
Тікелей алдын ала қарау және интерфейс мүмкіндіктері
Құрал мазмұнды құрастыру кезінде нақты уақыт режимінде нәтижені көруге мүмкіндік беретін тікелей алдын ала қарау (live preview) жүйесімен жабдықталған. Пайдаланушы сол жақтағы редакторға мәтін енгізгенде, оң жақ бөлікте оның форматталған нұсқасы бірден көрсетіледі.
Интерфейсте жұмысты ыңғайлы ету үшін келесі басқару элементтері қарастырылған:
- Көрініс режимдері: Пайдаланушы тек мәтін жазуға арналған «Жазу» режимі мен дайын нәтижені көруге арналған «Алдын ала қарау» режимі арасында ауыса алады.
- Қараңғы редактор: Көздің шаршауын азайту үшін редактордың қараңғы режимін (dark mode) қосу мүмкіндігі бар.
- Статистика: Редактордың төменгі жағында мәтіндегі «Сөздер» және «Таңбалар» саны нақты уақыт режимінде есептеліп тұрады.
Редактор бос болған кезде экранда «Дайын. Тікелей алдын ала қарауды көру үшін Markdown мәтінін жазыңыз немесе қойыңыз.» деген мәртебелік хабарлама тұрады. Алдын ала қарау аймағында «Форматталған алдын ала қарау нұсқасы осында пайда болады.» деген мәтін көрсетіледі. Пайдаланушы «Тазалау» түймесін басқан кезде, сөздер мен таңбалар саны нөлге қойылады, редактор босатылады және экранда «Редактор тазаланды.» деген хабарлама пайда болады.
PDF форматына экспорттау және басып шығару ережелері
Дайын құжатты экспорттау браузердің ішкі басып шығару жүйесі арқылы жүзеге асырылады. Пайдаланушы «PDF форматына экспорттау» түймесін басқан кезде, браузердің басып шығару терезесі ашылады. Бұл терезеде сақталатын жер ретінде «PDF ретінде сақтау» (немесе «Save as PDF») опциясын таңдау қажет. Осы кезеңде пайдаланушы беттің өлшемін, бағытын және жиектерін өзіне ыңғайлы етіп реттей алады.
Егер редактор бос болса және пайдаланушы экспорттау түймесін басса, браузердің басып шығару терезесі ашылмайды, ал экранда «Экспорттайтын ештеңе жоқ — алдымен Markdown мәтінін жазыңыз.» деген ескерту хабарламасы көрсетіледі.
Экспортталған PDF файлының басты ерекшелігі — оның ішіндегі мәтін сурет сияқты тегістеліп кетпейді. Ол нақты, іздеуге болатын мәтін түрінде сақталады және құжат ішіндегі сілтемелер белсенді күйінде қалады. Бұл құжатты оқушыларға мәтінді көшіруге және сілтемелер арқылы өтуге мүмкіндік береді.
Жиі қойылатын сұрақтар (FAQ)
Менің Markdown мәтінім серверге жүктеле ме?
Жоқ. Талдау, алдын ала қарау және PDF форматына экспорттау процестерінің барлығы браузеріңізде жергілікті түрде орындалады.
PDF файлын қалай алуға болады?
"PDF форматына экспорттау" түймесін басыңыз. Браузердің басып шығару терезесі ашылады — сақталатын жер ретінде "PDF ретінде сақтау" опциясын таңдаңыз.
PDF файлындағы мәтінді ерекшелеп көшіруге бола ма?
Иә. Экспорттау үшін браузеріңіздің ішкі басып шығару жүйесі қолданылады, сондықтан PDF файлында мәтінді іздеуге болады және сілтемелер белсенді күйінде қалады (бұл жай ғана сурет емес).
Қандай Markdown мүмкіндіктеріне қолдау көрсетіледі?
Тақырыптар, тізімдер, кестелер, код блоктары, дәйексөздер, сілтемелер, суреттер, қаріп мәнерлері және GitHub стиліндегі тапсырмалар тізімі.
Экспортталған PDF файлым қалай аталады?
PDF файлы Markdown құжатындағы бірінші # тақырыпты өзінің атауы және ұсынылатын файл аты ретінде пайдаланады. Егер Markdown құжатында негізгі тақырып болмаса, ол «Атаусыз құжат» ретінде экспортталады.