
Markdown — это лёгкий язык разметки для форматирования текста, который используется для создания структурированных документов, таких как README-файлы, статьи и комментарии, с использованием простого синтаксиса.
Основы
1. Заголовки:
# Заголовок h1для самого большого заголовка.## Заголовок h2для заголовка второго уровня.### Заголовок h3(и так далее до###### Заголовок h6) для последующих уровней.
2. Тэг:
#Тэг— тэг, так же как заголовок, но без пробела после#.
3. Форматирование текста:
*курсив*или_курсив_для курсива.**жирный**или__жирный__для жирного шрифта.~~зачеркнутый~~для зачеркнутого текста.==выделить текст==для подсветки текста.
4. Списки:
-
Для ненумерованных списков используйте
*,-или+. Пример:Пункт 1Пункт 2
-
Для нумерованных списков:
Первый пунктВторой пункт
-
Чекбоксы:
- Задача
- Выполненная задача
Синтаксис чекбокса:
- [ ] Задача
- [x] Выполненная задача5. Ссылки:
- `[Текст ссылки](URL)` для создания гиперссылки.
- `[[Внутренняя ссылка]]` — создаёт новую страницу.
- `[[Существующая ссылка|Текст]]` — внутренняя ссылка с кастомным текстом.
- `[[2023-01-01#^37066d|^37066d]]` — ссылка на блок в заметке.
6. HTML-вставки:
-
Видео:
<iframe width="300" height="169" src="https://www.youtube.com/embed/8owG83ozHYw" frameborder="0" allowfullscreen> </iframe> -
Пример вставки YouTube-видео:
-
Пример вставки любой страни:
<iframe border="0" frameborder="0" width="300" height="250" src="https://twitframe.com/show?url=https%3A%2F%2Ftwitter.com%2Fjack%2Fstatus%2F20"> </iframe> -
Пример вставки твита:
7. Изображения и ссылки на видео в стандартном размере:
8. Цитаты:
> Это пример цитаты.
> — Имя цитируемого, годРезультат:
Люди сталкиваются со всё более сложными и неотложными проблемами, и их эффективность в решении этих проблем имеет решающее значение для стабильности и дальнейшего прогресса общества.
— Дуглас Энгельбарт, 1961
9. Код:
- Для блока кода используйте три обратных апострофа :
- Откройте блок кода с помощью трёх апострофов
```. - Укажите сам код в строках ниже.
- Закройте блок кода ещё тремя апострофами
```.
- Откройте блок кода с помощью трёх апострофов
print("Привет, мир!")- Или четыре пробела перед каждой строкой:
print("Привет, мир!")
10. Сноски:
Пример[^1].
[^1]: Это сноска.11. Горизонтальные линии:
---или
***12. Таблицы:
- Выравнивание текста: Вы можете управлять выравниванием текста в столбцах, используя двоеточия : в строке разделителя.
- Для выравнивания по левому краю: :------------
- Для выравнивания по центру: :------------:
- Для выравнивания по правому краю: ------------:
- Гибкость: Столбцы не обязательно должны быть строго выровнены в Markdown, так как рендеринг Markdown сделает это автоматически. Главное — использовать вертикальные черты и дефисы в правильном порядке. - Пустые ячейки: Если вам нужна пустая ячейка, просто оставьте пространство между вертикальными чертами.
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
| ----------- | ----------- | ----------- |
| Данные 1.1 | Данные 1.2 | Данные 1.3 |
| Данные 2.1 | Данные 2.2 | Данные 2.3 |Пример:
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|---|---|---|
| Данные 1.1 | Данные 1.2 | Данные 1.3 |
| Данные 2.1 | Данные 2.2 | Данные 2.3 |
13. Разворачивающиеся списки:
<details>
<summary>Нажмите, чтобы открыть</summary>
<p>Содержимое разворачивающегося списка.</p>
</details>Пример:
Нажмите, чтобы открыть
Заголовок
Это само содержимое в markdown
14. Callouts (Выделенные блоки):
> [!note] Важно
>
> Это выделенный блок примечания.Пример:
Gliph
Пример доступных callouts:
note— Для общих примечаний.tip— Для советов и полезных рекомендаций.warning— Для предупреждений о потенциальных проблемах.danger— Для серьёзных предупреждений и опасностей.caution— Для осторожных напоминаний о возможных рисках.info— информацияtodo— todoabstract— рефератsummary— резюмеtldr(too long; didn’t read) — слишком длинно; не читалhint— подсказкаimportant— важноsuccess— успехcheck— проверитьdone— сделаноquestion— вопросhelp— помощьfaq— faq (часто задаваемые вопросы)attention— вниманиеfailure— провалfail— провалmissing— отсутствуетerror— ошибкаbug— ошибкаexample— примерquote— цитатаglyph— глиф
