MarkDown

Простой язык разметки для частичной замены HTML и DOCX. Содержит их основные наиболее популярные и нужные функции, но некоторый функционал не поддерживает.

Формат текста

Жирный

Чтобы получить курсив нужно выделить текст единичными *.

**текст жирный**
Example

текст жирный

Курсив

Чтобы получить курсив нужно выделить текст единичными *.

*текст курсивом*
Example

текст курсивом

Совмещение

Чтобы получить жирный курсив нужно выделить курсивом жирный текст или жирным выделить курсив.

*текст **жирным** курсивом*
Example

текст жирным курсивом

Зачёркнутый

Нужно выделить текст ~~.

~~тест~~ текст
Example

тест текст

Выделение

Нужно выделить текст ==.

Очень ==важная информация==
Example

Очень важная информация

Код

Выделить одну строчку кода (выделяется моноширинным шрифтом) можно с помощью `.

Функция `print()` выводит что-то
Example

Функция print() выводит что-то

Математические выражения

Для вставки математических выражений и формул нужно использовать LaTeX разметку заключённую в знаки $ или $$.

Это база: $\sin^2(x) + \cos^2(x) = 1$

Результат c $:
sin2(x)+cos2(x)=1
Результат c $$:

sin2(x)+cos2(x)=1

HTML форматирование

Также можно использовать HTML теги для форматирования. Например для подёргивания текста можно использовать тег <u>.

Обратите внимание на <u>14230 факт</u>
Example

Обратите внимание на 14230 факт

Заголовки

Помогают разделять информацию на странице. Существует 6 уровней заголовков. Создаются с помощью знака # и пробела после него.

# Заголовок 1 уровня
## Заголовок 2 уровня
### Заголовок 3 уровня
#### Заголовок 4 уровня
##### Заголовок 5 уровня
###### Заголовок 6 уровня
Example

Заголовок 1 уровня

Заголовок 2 уровня

Заголовок 3 уровня

Заголовок 4 уровня

Заголовок 5 уровня
Заголовок 6 уровня

Списки

Списки могут быть

Нумерованными

Создаются с помощью цифры + точки + пробела.

1. Первое
2. Второе
3. Третье
Example

  1. Первое
  2. Второе
  3. Третье

Ненумерованными

Которые могут быть

Обычными

Создаются с помощью тире + пробела

- Первое
- Второе
- Третье
Example

  • Первое
  • Второе
  • Третье

Чтобы создать многоуровневый список нужно сделать отступ (клавиша Tab).

- Первое
- Второе
	Здесь ещё несколько пунктов
	- Второе.Первое
	- Второе.Второе
- Третье
Example

  • Первое
  • Второе
    Здесь ещё несколько пунктов
    • Второе.Первое
    • Второе.Второе
  • Третье

Чек-листами

Создаются с помощью тире + пробела + квадратных скобок с пробелом или буквой x внутри + пробела

- [ ] Первое
- [x] Второе (сделанно)
- [ ] Третье
Example

Ссылки

Ссылки выглядят так:

[Текст ссылки](https://github.com/)
Example

Для вставки изображения нужно добавить ! перед ссылкой. В этом случае текст ссылки будет использоваться если изображение не удалось загрузить и программами для чтения с экрана (для слепых).

![Текст ссылки](https://i.ytimg.com/vi/P0FwKZ-ay0Y/maxresdefault.jpg)
Example

Текст ссылки

В MarkDown нельзя изменить размер изображения, если нужно это сделать то придётся использовать HTML тег img и атрибуты width (ширина) и height (высота).

<img alt="Текст ссылки" src="https://i.ytimg.com/vi/P0FwKZ-ay0Y/maxresdefault.jpg" width=256px> 
Example

Текст ссылки

Wiki-ссылки

Некоторые сервисы позволяют для ссылки на внутренние заметки и изображения использовать Wiki-ссылки. В этом случае можно поменять размер изображения так ![Data/USB_Type-C_Female.png|высота](/img/user/Data/USB_Type-C_Female.png)

eliaizer space
![Data/USB_Type-C_Female.png|128](/img/user/Data/USB_Type-C_Female.png)
Example

[[eliaizer space]]
Data/USB_Type-C_Female.png|128

Такие ссылки работают только для локальных заметок и картинок.

Блоки

Цитата

Блок с цитатой можно сделать с помощью >. После него весь текст до следующего абзаца будет считаться цитатой.

> **Лев** если на пары и сходил, то лекции не записывал. Так чисто отметиться пришел и в *тикитоках* посидеть, без удовольствия.
Example

Лев если на пары и сходил, то лекции не записывал. Так чисто отметиться пришел и в тикитоках посидеть, без удовольствия.

Многострочный код

Для вставки программы бывает удобно использовать отдельный блок кода, а не строчку. Блок выделяется ``` и после первого ограничителя можно написать название языка для автоматического цветного форматирования и подписи

Example

```python
print(f"новая {5+2} строк")
```

Example

print(f"новая {5+2} строк")

Инфоблоки (callout-блоки)

Позволяют выделить контент графически с помощью блока. Существуют стандартные блоки, но можно сделать и свой (придётся покопаться в CSS чтобы получилось).
Так выглядит создание стандартного callout-блока:

> [!bug]
> Абоба
Bug

Абоба

Если вместо bug или другого стандартного слова написать своё то в любом случае будет стандартное окно с нейтральным стилем:

> [!YADERKA]
> СПАСАЙТЕСЬ!!!
Yaderka

СПАСАЙТЕСЬ!!!

Чтобы это настроить нужно изменить тему через CSS.

Таблицы

Таблицы имеют следующий синтаксис (количество - на 2 строке может быть любым, но для красоты можно сделать примерно длиной с заголовок). Можно делать пустые ячейки

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|-|-------------|-----|
| Ячейка 1    | Ячейка 2    |Ячейка 3  |
| Данные A    | Данные B    | |
Example

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|-|-------------|-----|
| Ячейка 1 | Ячейка 2 |Ячейка 3 |
| Данные A | Данные B | |

Для выравнивания текста внутри ячейки нужно добавить : в ячейку 2 строки нужной колонки с того края куда нужно прижимать текст.

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|:------------|------------:|-------------|
| Ячейка 1    | Ячейка 2    | Ячейка 3    |
| Данные A    | Данные B    | Данные C    |
Example

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|:------------|------------:|-------------|
| Ячейка 1 | Ячейка 2 | Ячейка 3 |
| Данные A | Данные B | Данные C |

Продвинутые функции

Экранирование

Чтобы вставить какой-то символ который в разметке MarkDown для чего то используется (например * или ==) нужно использовать \. Если поставить его перед * то она перестаёт функционировать и становиться обычным символом. При этом самого знака \ видно не будет.

HTML

Возможности HTML гораздо больше MarkDown. Например можно покрасить текст в определённый цвет:

<span style="color:red;">AAAAA</span>
Example

AAAAA

Использовать верхний, нижний индекс:

Это H<sub>2</sub>O и E = mc<sup>2</sup>
Example

Это H2O и E = mc2

Создавать свои блоки:

Мой HTML-блок

Здесь я могу вставить любой HTML

Кнопка

И многое другое.