Маркдаун е средство за конвертиране на обикновен текст в HTML-формат. Той е създаден да е лесен за четене и писане, и удобен за преобразуване в структурно валиден XHTML/HTML-формат.
Тоест маркдаун представлява две неща:
-
синтаксис за форматиране на обикновен текст с не-азбучни знаци като
#,*,_,>,|, и др.; -
софтуерен инструмент, написан на програмния език Perl, който конвертира обикновен текст в HTML-формат.
Маркдаун е създаден през 2004 г. от Джон Грубър и се разпространява под лиценз за отворен код BSD. Основната цел на създателя му е да направи удобен формат за писане в Интернет. Маркдаун не е заместител на HTML, а опростен синтаксис за четене, писане и редактиране на уеб съдържание.
Синтаксисът на маркдаун е много достъпен и лесен за бързо усвояване, и затова днес той се радва на широко разпространение и употреба (напр. на сайтове като Github 
и Reddit).
За да започнете да работите с маркдаун Ви е необходим текстов редактор. В него към обикновения текст се прибавят форматиращите елементи на маркдаун синтаксиса.
Има и по-усъвършенствани приложения, които поддържат писането на маркдаун синтаксис и предлагат автоматичен преглед на конвертирания в HTML файл. Такива са напр. онлайн текстовия редактор Dillinger, или текстовия редактор от GitHub — Atom.
Когато пишете с маркдаун, информацията се записва като файл в обикновен текстов формат с файлово разширение .md или .markdown.
Този раздел съдържа основния синтаксис за маркдаун както е създаден първоначално. С широкото разпространение на употребата му се налага надграждане на функционалността с допълнителни екстри, които ще бъдат разгледани в раздела Разширен синтаксис.
Има два вида синтаксис за заглавия: setext и atx.
Синтаксисът за setext стила важи само за 1-во и 2-ро ниво заглавия (т.е. <h1> и <h2> в HTML). За да форматираме Заглавие 1, текстът се подчертава с няколко знака за равенство =.
Маркдаун синтаксис:
Заглавие 1
======
Резултат:
За да форматираме Заглавие 2, текстът се подчертава с няколко минуса -.
Маркдаун синтаксис:
Заглавие 2
------
Резултат:
Синтаксисът за atx стила се прилага на заглавия от 1-во до 6-то ниво (т.е.<h1> до <h6> в HTML). За да форматираме такива заглавия пред текста им се поставят съответно от един до шест знака диез #.
Маркдаун синтаксис:
# Заглавие 1
## Заглавие 2
### Заглавие 3
#### Заглавие 4
##### Заглавие 5
###### Заглавие 6
Резултат:
Маркдаун позволява оформянето на нови параграфи по два начина:
-
твърд преход: чрез прехвърляне на нов ред с клавиша
Enter, и -
мек преход: чрез поставянето на два празни интервала на края на предходния ред.
Удебелен текст
За удебеляването на текст той се обгражда в началото и в края с по два символа звезда **, напр. **удебелен** текст. Символите ** могат да бъдат заменени и с по два символа долна черта __ за постигането на удебелен текст.
Курсивен текст
Курсивният ефект в маркдаун се получава след затварянето на текста в началото и в края с по един знак долна черта _, напр. _курсивен_ текст. Знакът _ може да бъде заменен и с по една * за постигането на същия ефект.
Удебелен и курсивен текст
Двете комбинации от символи могат да се съчетаят за постигането на двоен ефект: удебелен и курсивен. Текстът се обгражда в началото с **_и в края с _**, напр. **_удебелен и курсивен_** текст (или алтернативно с __* и *__).
За създаването на интерактивна връзка маркдаун използва следния синтаксис: започва се с описание на препратката в структурни (квадратни) скоби [] и непосредствено след тях в обикновени скоби () следва URL-адреса на линка. Резултатът е интерактивна препратка състояща се само описанието на връзката.
[Описание на връзката](http:// интернет адрес на препратката)
[Проектът маркдаун на Джон Грубър](https://daringfireball.net/projects/markdown/)
Проектът маркдаун на Джон Грубър
URL-линковете и имейл адресите се разпознават автоматично и се превръщат в интерактивни линкове. По желание могат да бъдат обградени в ъглови скоби <>.
<john.doe@email.com>
<https://daringfireball.net/projects/markdown/>
https://daringfireball.net/projects/markdown/
Вмъкването на изображения в маркдаун следва същия синтаксис като създаването на интерактивни препратки с единствената разлика, че при изображенията се започва със знак удивителна !. Удивителната е последвана от наименованието на изображението в структурни (квадратни) скоби [], а непосредствено след това в обикновени скоби () се задава URL-адреса или абсолютната/относителната пътека към източника на изображението. По желание след източника в същите скоби, но в кавички "", може да се добави и подсказващ текст с описание на изображението, който да се показва при преминаването на курсора/стрелката на мишката над него.
За да маркирате даден текст като цитат започнете параграфа със знак за по-голямо >. Ако цитатът се състои от няколко реда, започвайте всеки ред със знак >, дори и празните редове, за да създадете компактен параграф-цитат. Самият текст на цитата може да бъде форматиран допълнително както е показано на по-долния пример.
> **О, неразумний и юроде, поради что се срамиш да се наречеш болгарин?**
>
> _Паисий Хилендарски, „История славянобългарска“_
О, неразумний и юроде, поради что се срамиш да се наречеш болгарин?
Паисий Хилендарски, „История славянобългарска“
Номериран списък в маркдаун се създава със задаване на номер, последван от ., интервал и текст. Номерираният списък винаги трябва да започва с 1.
1. Едно
2. Две
3. Три
- Едно
- Две
- Три
Индексираният списък в маркдаун може да се създаде с няколко еквивалентни знака: *, + или -. Всеки от тези знаци може да се използва за създаването на списък, индексиран с точки.
* Първо
+ Второ
- Трето
- Първо
- Второ
- Трето
Вложеният списък съдържа главни точки и вложени в тях подточки. И номерираните, и индексираните списъци могат да съдържат подточки. В маркдаун подточките се създават като въведете на нов ред четири празни интервала (или едно натискане на клавиша Tab), последван от някой от знаците за създаване на индексиран списък и текста на подточката.
1. Едно
* едно и половина
* Две
- две и половина
- Едно
- едно и половина
- Две
- две и половина
Маркдаун често се използва за създаването на техническа документация. Ако дадена дума или фраза трябва да бъде обозначена като компютърен код, тя се загражда със знак за ударение [ ` ].
компютърен код
Ако програмният код се състои от няколко реда и трябва да се форматира в собствен блок/параграф, тогава всеки нов ред от кода трябва да бъде вмъкнат с четири интервала навътре (или с едно натискане на клавиша Tab).
<!DOCTYPE html>
<html>
<head>
...
</head>
<body>
...
</body>
</html>
Разширеният синтаксис на маркдаун предлага още опции за форматиране на компютърен код.
С помощта на три или повече специални знака като минус -, звезда * или долна черта _ можете да създадете хоризонтална разделителна линия. Ако желаете, можете да поставите и интервали между отделните символи. Всеки от долупосочените варианти води до един и същи резултат.
Маркдаун синтаксис:
---
- - -
***
* * *
___
**************
Резултат:
Понякога текстът трябва да съдържа буквално някои от специалните знаци, които се използват за форматирането в маркдаун. За да се избегне форматиращата им функция, тези знаци трябва да се предходят със знака обратно наклонена диагонална черта \.
\* Без обратно наклонената диагонална черта това изречение ще се форматира като точка от индексиран списък.
* Без обратно наклонената диагонална черта това изречение ще се форматира като точка от индексиран списък.
Функционалността на следните специални знаци в маркдаун може да бъде блокирана с добавянето на обратно наклонена диагонална черта \ пред тях:
| Специален знак | Пояснение |
|---|---|
| . | точка |
| ! | удивителна |
| + | плюс |
| - | минус |
| _ | долна черта |
| * | звезда |
| ` | ударение |
| \ | обратно наклонена диагонална черта |
| # | диез |
| ( ) | обикновени скоби |
| [ ] | структурни (квадратни) скоби |
| { } | къдрави скоби |
С годините маркдаун набира широка популярност и употреба, но основният му синтаксис се оказва недостатъчен за нуждите на публикуването на уеб съдържание. Затова много хора и организации започват да надграждат функционалността на маркдаун с допълнителни екстри. Този раздел представя допълнителните елементи добавени към първоначалния синтаксис на маркдаун като най-вече се набляга на т.нар. GFM (GitHub Flavored Markdown) — маркдаун синтаксис, който се използва на популярната платформата за сътрудничество на софтуерни разработчици GitHub.
Текстовите редактори и приложения използват различни маркдаун процесори и не всички от тях поддържат разширения маркдаун синтаксис. Необходимо е предварително да проверите докъде се простира функционалността на вашия софтуер и дали може да бъде надградена.
Таблиците в маркдаун се създават с помощта на знака вертикална черта |. С него се разделят и форматират отделните таблични колони.
Първият ред на таблицата автоматично се оформя със заглавие в удебелен шрифт за всяка от колоните.
Вторият ред на таблицата се състои само от по няколко знака минус --- във всяка от колоните. Той маркира границата между заглавния ред и останалите редове с данни. Тук се създава и форматирането на текста във всяка от колоните — той може да бъде фиксиран вляво, вдясно или центриран. Форматирането на колоните се задава с помощта на знаците двоеточие : и минус -. Двоеточието : определя форматирането на текста в зависимост от това как е поставено спрямо знаците минус -. За фиксиран вляво текст двоеточието се поставя отляво на минусите :---; за фиксиран вдясно текст двоеточието се поставя отдясно на минусите ---:, а за центриран текст се поставя знак двоеточие и от двете страни на знаците минус :---:.
Всеки следващ ред съдържа данните от таблицата като всяка колона се оформя с разделителен знак |. Тези знаци, по желание, могат да бъдат пропуснати в началото и в края на всеки ред, но не и като разделители на отделните таблични колони, защото с тяхна помощ се фиксира информацията в отделните клетки на таблицата.
В таблицата може да се използва и допълнително форматиране с удебелен и курсивен текст, компютърен код или интерактивни препратки. Табличните клетки не могат да се форматират със заглавия, цитати, списъци, хоризонтални линии, изображения или HTML елементи.
| Колона 1 | Колона 2 | Колона 3 |
| :--- | :---: | ---: |
| вляво | центриран | вдясно |
| **вляво** | **центриран** | **вдясно** |
| _вляво_ | _центриран_ | _вдясно_ |
| **_вляво_** | **_центриран_** | **_вдясно_** |
| Колона 1 | Колона 2 | Колона 3 |
|---|---|---|
| вляво | центриран | вдясно |
| вляво | центриран | вдясно |
| вляво | центриран | вдясно |
| вляво | центриран | вдясно |
Списъкът със задачи се състои от отделни подточки, подредени в листа една под друга, като всяка от тях се предхожда от квадратче, в което чрез кликване в него, може се постави отметка.
Всеки нов ред от списъка започва със знак минус -, последван от интервал, празни квадратни скоби и след тях се въвеждат необходимите данни. Ако някоя от задачите в списъка е предварително изпълнена, то тя може да се маркира като такава още в маркдаун синтаксиса като между квадратните скоби се постави един знак хикс: [x].
- [x] Задача 1 ==> _маркирана изпълнена_
- [ ] Задача 2
- [ ] Задача 3
- [ ] Задача 4
- Задача 1 ==> маркирана изпълнена
- Задача 2
- Задача 3
- Задача 4
Ефектът на задраскан текст в маркдаун синтаксиса се постига с ограждането на текста от двете страни със знака тилда ~.
~задраскан текст~
задраскан текст
Разширеният синтаксис на маркдаун позволява форматирането на сектор от компютърен код с цветово кодиране според използвания програмен език. Началото на блока компютърен код се маркира с три знака за ударение последвани от наименованието на програмния език, напр. ```javascript. След това на нов ред започва програмния код, а последният ред завършва с три знака за ударение ```, които маркират края на сектора компютърен код.
<!DOCTYPE html>
<html lang="bg-BG">
<head>
<title>Това е ограден сектор с компютърен код</title>
</head>
<body>
<h1>Първи стъпки с маркдаун</h1>
</body>
</html>Споменаването на потребители, екипи, организации, и пр. спомага за подобряване на комуникацията. Ако във вашия маркдаун синтаксис включите кльомба @, последвана от потребителско име, то въпросните упоменати ще бъдат информирани автоматично, че са споменати от Вас, след публикуването на текста.
@потребителско-име
Всеки номер в GitHub, който се отнася до казус (Issue) или искане за преглед и ревизия на код (Pull Request), автоматично се форматира като интерактивна връзка.
#1
github-flavored-markdown#1
defunkt/github-flavored-markdown#1
Може да разчупите типографското оформление на вашия документ с употребата на емотикони. Маркдаун синтаксисът изисква наименованието на емотиконите да е обградено със знак двоеточие :.
:smile: 😄
:rocket: 🚀
:octocat:
Кодовете на повечето популярни емотикони, с които да освежите проекта си, можете да намерите тук.
⬇️ ⬇️ ⬇️
Свалете своя маркдаун „пищов“ в .pdf-формат тук! 🔫
Допълнителна информация: 🔗