Запознайте се с Markdown
Markdown е език за форматиране на текст. Благодарение на него записките винаги изглеждат перфектно структурирани и галещи окото. Стига да спазвате някои елементарни правила, без много усилия, ще създавате съвършено изглеждаща документация. Голямо предимство на писането в Markdown формат е, че не ви е необходим специализиран софтуер. Достатъчно е да разполагате с най-обикновен текстов редактор и сте готови. Да! Дори и Notepad ви е достатъчен!😆
Форматирането ще представям първо като код, а след това крайният резултат до който води.
Заглавия
1
2
3
4
5
# Заглавие 1
## Заглавие 2
### Заглавие 3
#### Заглавие 4
##### Заглавие 5
Заглавие 1
Заглавие 2
Заглавие 3
Заглавие 4
Заглавие 5
Стил на текста
За пример тук ще използвам на пръв поглед безсмисленото изречение: Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон. Но това не е случайно. Такова изречение се нарича панграма, тъй като съдържа всички букви от българската азбука.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
### Удебелен шрифт
**Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.**
__Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.__
### Наклонен шрифт (курсив)
*Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.*
_Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон._
### Удебелен и наклонен шрифт
***Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.***
___Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.___
Удебелен шрифт
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Наклонен шрифт (курсив)
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Удебелен и наклонен шрифт
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Блок за цитат
1
2
3
4
5
6
7
8
9
> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
>
> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
>
> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
>> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
>>> Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон. Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон. Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Задраскване на текст
1
2
3
Задраскан текст
~~Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.~~
Задраскан текст
Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Горен индекс
1
2 <sup>53-1</sup> и -2 <sup>53-1</sup>
2 53-1 и -2 53-1
Долен индекс
1
2
3
Долен индекс
<sub>Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.</sub>
Долен индекс Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
Таблици
1
2
3
4
5
6
| По подразбиране | Ляво подравняване | Центрирано | Дясно подравняване |
| --------------- |:------------------|:----------:|-------------------:|
| 9999999999 | 9999999999 | 9999999999 | 9999999999 |
| 999999999 | 999999999 | 999999999 | 999999999 |
| 99999999 | 99999999 | 99999999 | 99999999 |
| 9999999 | 9999999 | 9999999 | 9999999 |
| По подразбиране | Ляво подравняване | Центрирано | Дясно подравняване |
|---|---|---|---|
| 9999999999 | 9999999999 | 9999999999 | 9999999999 |
| 999999999 | 999999999 | 999999999 | 999999999 |
| 99999999 | 99999999 | 99999999 | 99999999 |
| 9999999 | 9999999 | 9999999 | 9999999 |
Линкове
1
[Chatrix.One - Документация](https://docs.chatrix.one)
Имейл адреси
1
<justin.tester@nonexistent.mail>
justin.tester@nonexistent.mail
Изображение
От линк
1
Изображението се зарежда и визуализира от посочения линк.
Локално
1
Изображението се зарежда и визуализира от локално хранилище.
Списъци
1
2
3
1. Едно
2. Две
3. Три
- Едно
- Две
- Три
1
2
3
4
5
6
7
8
1. Първо ниво
1. Второ ниво
- Трето ниво
- Четвърто ниво
2. Първо ниво
1. Второ ниво
3. Първо ниво
1. Второ ниво
- Първо ниво
- Второ ниво
- Трето ниво
- Четвърто ниво
- Трето ниво
- Второ ниво
- Първо ниво
- Второ ниво
- Първо ниво
- Второ ниво
1
2
3
4
5
6
7
8
9
10
11
* 1
* 2
* 3
+ 1
+ 2
+ 3
- 1
- 2
- 3
- 1
- 2
3
- 1
- 2
3
- 1
- 2
- 3
1
2
3
4
5
6
7
8
- Първо ниво
- Второ ниво
- Трето ниво
- Четвърто ниво
- Първо ниво
- Второ ниво
- Първо ниво
- Второ ниво
- Първо ниво
- Второ ниво
- Трето ниво
- Четвърто ниво
- Трето ниво
- Второ ниво
- Първо ниво
- Второ ниво
- Първо ниво
- Второ ниво
1
2
3
- [x] Череши 1кг
- [ ] Баклава 1/4кг
- [ ] Плащане на телефон
- Череши 1кг
- Баклава 1/4кг
- Плащане на телефон
Бутони, клавиши
1
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>
Ctrl + Shift + P
1
<kbd> <br> Ctrl + Shift + P <br> </kbd>
Ctrl + Shift + P
Хоризонтални линии
1
2
3
4
5
6
7
8
9
10
11
12
13
## Хоризонтални линии
Вариант едно
___
Вариант две
* * *
Вариант три
___
Без значение кой вариант ще изберете, резултатът ще бъде един и същ
Бележки под чертата
1
2
3
4
5
6
Chatrix.One е сървър предлагащ комуникация, базирана на XMPP[^1] протокол.
Комуникацията е криптирана[^2] посредством OMEMO[^3].
[^1]: XMPP - Extensible Messaging and Presence Protocol;
[^2]: Известно още като шифроване;
[^3]: OMEMO представлява метод за двойно криптиране на комуникацията от край до край;
Chatrix.One е сървър предлагащ комуникация, базирана на XMPP1 протокол. Комуникацията е криптирана2 посредством OMEMO3.
Където и да поставите описанието в редактора, то винаги ще се визуализира в най-долната част на документа.
Вграждане на код
С цел правилно визуализиране, посоченият код е под формата на изображение.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Brute force with a try-except block (Python 3+)
try:
with open('/path/to/file', 'r') as fh:
pass
except FileNotFoundError:
pass
# Leverage the OS package (possible race condition)
import os
exists = os.path.isfile('/path/to/file')
# Wrap the path in an object for enhanced functionality
from pathlib import Path
config = Path('/path/to/file')
if config.is_file():
pass
Команди за изпълнение под терминал
1
`cat /etc/os-release`
cat /etc/os-release
Диаграми
С цел правилно визуализиране, посоченият код е под формата на изображение.
pie
"Мазнини" : 60
"Белтъчини" : 30
"Въглехидрати" : 10
Блок схема
С цел правилно визуализиране, посоченият код е под формата на изображение.
graph LR
A[Правоъгълник] -- Текст над стрелка --> B((Кръг))
A --> C(Заоблен правоъгълник)
B --> D{Ромб}
C --> D
Математически изрази
1
Вграден (на реда) математически израз $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
Вграден (на реда) математически израз $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
1
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
С тези знания можете да сътворите чудеса. Имайте предвид, че това далеч не е всичко, но за повечето хора е повече е достатъчно за създаването на една безупречно организирана документация.