Ця сторінка виглядає краще якщо JavaScript працює

Markdown базовий синтаксис

 ·  ☕ 6 хв читати

Основний синтаксис

Елементи Markdown, викладені в проектному документі Джона Грубера

Огляд

Майже всі додатки Markdown підтримують основний синтакси, ивкладений в проектному документі Джона Грубера. Між процесорами Makrdown є розбідності та основні елементи залишаються вбудованими

Заголовки

Щоб створити заголовки, додайте перед словом чи фразою знак “дієз” #. Кількість знаків відповідає рівню заголовка. Наприклад, щоб створити заголовок рівня <h3> потрібно використати три знаки “решітки”

# Рівень перший
## Рівень другий
### Рівень третій
#### Рівень четрвертий
##### Рівень п'ятий
###### Рівень шостий

Альтернативний синтаксис

Існує та пітримується альтенативний синтаксис для виділення заголовків першого та другого рівнів. Щоб виділити заголовок першого рівня його потрібно “підкреслити” знаками рівності =, а другого - “мінусом” -

1
2
3
4
5
Заголовок першого рівня
=======================

Заголовок другого рівня
-----------------------

Кількість знаків що підкреслюють може бути довільною, але не меншою 3 знаків.

Рекомендується після та перед рядком заголовку робити принаймі оди порожній рядок, а також після символу # також ставити принаймі один пробільний символ

Абзаци

Для того щоб створити абзац потрібно розділити його від наступного чи попереднього принаймі одним порожнім рядком.

Ні в якому разі не робліть відступи нового абзацу пробілами чи табуляцією!

Розриви рядка

Щоб зробити примусовий розрив рядка закінчте рядок двома або більше пробільними символами та натисніть клавішу переведення рядка ([ENTER]).

Акцент

Ви можете робити наголос на певних словах у тексті

Курсив

Щоб виділити фрагмент тексту додайте на початку фрагменту та в кінці одну зірочку чи знак підкреслення

1
*курсив* та _курсив_

Отримаєте курсив та кусив. Якщо потрібно виділити курсивом одну літеру у слові РЕКОМНЕДУЄТЬСЯ використовувати зірочку!!!

Жирний

Щоб виділити текст напівжирним потрібно перед та після потрібного фрагменту поставити дві зірочки чи два знаки підкреслення

1
**жирний текст** __жирний текст__

Ви отримаєте жирний текст жирний текст. Але якщо вам потрібно виділити кілька символів в одному слові РЕКОМЕНДУЄТЬСЯ використовувати зірочки, текст лі__Т__ера не буде віділяти літеру T. Правильним буде використання наступного коду

1
лі**Т**ера

ліТера

Жирний курсив

Щоб виділити текст жирним курсивом потрібно обмежити фрагмент текст трьома зірочками або знаками підкреслення

1
2
3
4
*__це жирний курсив__*
___це також жирний курсив___
***і це жирний курсив***
__*і це жирний курсив*__

Якщо потрібно жирним курсивом фрагмент слова РЕКОМНЕДУЄТЬСЯ використовувати зірочки!!!

Блок цитати

Щоб сторити блок цитату, додайте знак > перед абзацом

1
> Дороті йшла за нею через багато прекрасних кімнат у своєму замку

Матиме вигляд:

Дороті йшла за нею через багато прекрасних кімнат у своєму замку

Цитати кількох абзаців

Щоб процитувати кілька абзаців потрібно порожні рядки почати із знаку більше

1
2
3
> Дороті йшла за нею через багато прекрасних кімнат у своєму замку
>
> Відьма наказала їй почистити кастрюлі та чайники, підмітати підлогу та підтримувати вогонь

Матиме вигляд

Дороті йшла за нею через багато прекрасних кімнат у своєму замку

Відьма наказала їй почистити кастрюлі та чайники, підмітати підлогу та підтримувати вогонь

Вкладені цитати

Цитати можна вкладати. Для цього кількістю знаків > вкажемо рівень вкладеності

1
2
3
4
> Дороті йшла за нею через багато прекрасних кімнат у своєму замку
>
>> Відьма наказала їй почистити кастрюлі та чайники, підмітати підлогу та підтримувати вогонь
>

Матиме вигляд

Дороті йшла за нею через багато прекрасних кімнат у своєму замку

Відьма наказала їй почистити кастрюлі та чайники, підмітати підлогу та підтримувати вогонь

Форматування блок цитат

Блок цитата може містити інші елементи форматування Markdown. Ви повинні мату на увазі, що не всі елементи можуть підтримуватися і щоб дізнатися чи вони працюють потрібно буде поексперементувати

Списки

Ви можете організовувати пронумерований та не номурований списки

Впорядковани список

Щоб сторити пронумерований список потрібно поставити цифру з крапкою. Важливо, що перший рядок повинен починатися з 1 далі порядок та нумерація списку не є важливою. Список буде пронумерований у порядку в якому написані елементи

1
2
3
4
1. Перший пукнт
3. Другий пункт
2. Третій пункт
4. Четрвертий пункт
  1. Перший пукнт
  2. Другий пункт
  3. Третій пункт
  4. Четрвертий пункт

Маркований список

Щоб створити невпорядкований список, додайте тире, зірочку або плюс на початку рядків з позиціями

1
2
3
+ Елемент списку
+ Інший елемент списку
+ Іще один елемнт списку
  • Елемент списку
  • Інший елемент списку
  • Іще один елемнт списку

Вкладені списки

Ви можете комбінувати впорядкований та невпорядковані списки створюючи багаторівневі вкладені списки. Для цього потріьно зробити відступ для наступного рівня

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
+ Літери
    - Великі
        * А
        * Б
        * В
        * ...
    - Маленькі
        * а
        * б
        * в
        * ...
+ Цифри
    1. 1
    2. 2
    4. 3
    3. 4
    5. ...
  • Літери
    • Великі
      • А
      • Б
      • В
    • Маленькі
      • а
      • б
      • в
  • Цифри
    1. 1
    2. 2
    3. 3
    4. 4

Невпорядкований список з цифрою

Якщо вам потрібен не впорядкований список елементів який починається з цифри за яким слідує крапка, ви можете скористатися зворотьою рискою для виведення крапки

1
2
- 1968\. Чудовий рік
- Я ввіжаю, 1969 рік був друним кращим
  • 1968. Чудовий рік
  • Я ввіжаю, 1969 рік був друним кращим

Додавання елементів у списки

Щоб додати ще один елемент до списку, зберігаючи безперевність списку, потрібно відступити на чотири пробіли або на один таб, як показано у наступних прикладах

Абзаци

1
2
3
4
5
6
* Це перший пункт
* Це другий елемент списку
    
    Я додаю абзац у другий пункт списку

* Це третій пункт

Це матиме вигляд:

  • Це перший пункт

  • Це другий елемент списку

    Я додаю абзац у другий пункт списку

  • Це третій пункт

Блок-цитати

1
2
3
4
5
6
* Це перший пункт
* Це другий елемент списку
    
    > Я додаю цитату до другого елементу списку

* Це третій пункт

Це матиме вигляд:

  • Це перший пункт

  • Це другий елемент списку

    Я додаю цитату до другого елементу списку

  • Це третій пункт

Tux

Блоки коду

```lang
    example
```

Горизонтальна риска

Щоб створити горизонтальну риску використовуйте ти або більше зірочок ***, тире ---, підкреслення ___ у рядку

1
2
3
4
5
6

*****************

-----------------

_________________

Всі три варіанти будуть вигялдати однаково




Посилання

Щоб створити посилання, додайте текст посилання в прямокутних дужках, а потім одразу за ним в дужках адресу посилання.
Дивись приклад

1
Я відмовся від Google пошукової системи на користь [Duck Duck Go](https://duckduckgo.com "Пошукова система яка береже вашу приватність")

Я відмовся від Google пошукової системи на користь Duck Duck Go

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a hobbit-hole, and that means comfort.

Картинка

Щоб додати зображення потрібно додати знак оклику за яким повторіть синтаксис вставки лінку. Ви можете за бажанням додати заголовок пісял URL-адреси в дужках.

1
![this-is-robot-in-space](/gallery/cartoon/robot-in-space-4556429_640.png "robot in space")

Результат вигялдатиме так:

this-is-robot-in-space

Спеціальні символи

Спеціальні симовли використовується для форматування тексту. Краще уникати їх використання без екранування. Щоб екранувати символ, перед його виведенням краще поставити зворотню риску.

СимволНазва
\Зворотня риска
`Зворотній апостроф
*Зірочка
_Підкреслення
{}Фігурні скобки
[]Прямокутні скобки
<>Трикутні скобки
+Плюс
-Мінус
.Крапка
|Риска
1
2

\* Без зворотьої риски це було б маркером у не впорядкованому списку

* Без зворотьої риски це було б маркером у не впорядкованому списку

HTML

З міркувань безпеки не всі програми Markdown підтримують HTML. Якщо ви сумніваєтесь, перевірте документацію програми. Деякі програми підтримують лише підмножину тегів HTML

Поширити в
Підтримайте автора

Sam4uk
НАПИСАВ
Sam4uk
Embedded Software Engineare C/C++