✨ Базовый Markdown синтаксис
Здесь описывается базовый markdown синтаксис.
Маркдаун - это#
Markdown(Маркдаун) — лёгкий в использовании синтаксис для безопасного форматирования вашего текста или статей. На столько “лёгкий”, что нужна целая статья для разъяснения - что к чему.
Зачем статья про Маркдаун то?#
Предположим, что у моего клиента блог написан на Astro ↗ и у него не подключена “Headless” CMS ↗, такая как Wordpress. То его статья написана, как раз, в Markdown файле ↗. Вот тут-то и пригодится эта “шпаргалка”. Я, бывает, забываю синтаксис, пригодится.
Заголовки#
Когда текста становится слишком много, то понятно нужны заголовки, что-бы разбить его.
# Заголовок 1
## Заголовок 2
## Большой заголовок
### Маленький заголовокmarkdownЖирный и курсив#
_Курсивный текст_ и **Жирный текст СТРОНГ**, вместе тоже можно **_Жирный курсивом текст_**markdownПредпросмотр:
Курсивный текст и Жирный текст СТРОНГ, вместе тоже можно Жирный курсивом текст
Ссылки#
Текстовая ссылка [Имя ссылки](https://link-url)markdownПредпросмотр:
Текстовая ссылка Имя ссылки ↗
Inline код или “Код в строку”#
Это `inline код`markdownПредпросмотр:
Это inline код
Блок кода#
```js
// Последовательность фибоначчи
function fibonacci(n) {
if (n <= 1) return 1
const result = fibonacci(n - 1) + fibonacci(n - 2) // [\!code --]
return fibonacci(n - 1) + fibonacci(n - 2) // [\!code ++]
}
```markdownПредпросмотр:
// Последовательность фибоначчи
function fibonacci(n) {
if (n <= 1) return 1
const result = fibonacci(n - 1) + fibonacci(n - 2)
return fibonacci(n - 1) + fibonacci(n - 2)
}jsИспользуется Shiki как плагин подсветки кода. Тут смотреть поддерживаемые языки Shiki: Языки ↗.
Строчная формула#
Формулы — тоже выводятся плагином.
Это строчная формула $e^{i\pi} + 1 = 0$markdownПредпросмотр:
Это строчная формула
Блок формул#
$$
\hat{f}(\xi) = \int_{-\infty}^{\infty} f(x) e^{-2\pi i x \xi} \, dx
$$markdownПредпросмотр:
Используется KaTeX как плагин для формул. Тут KaTeX поддерживаемые функции ↗.
Изображения#
markdownПредпросмотр:
![]()
Перечёркнутый текст#
~~Перечёркнутый~~markdownПредпросмотр:
Перечёркнутый
Списки#
Обычный ненумерованный список
- 1
- 2
- 3markdownПредпросмотр:
- 1
- 2
- 3
Обычный нумерованный список
1. Раз
2. Два
3. ТриmarkdownПредпросмотр:
- Раз
- Два
- Три
Цитата#
> Выстрел, гром, меч из ножен. Цветы и кровь.markdownПредпросмотр:
Выстрел, гром, меч из ножен. Цветы и кровь.
You can continue to nest syntax within blockquotes.
Перенос строки#
В Маркдауне нужно оставить пустую строку для разделения параграфов.
Если не оставить пустую строку
То это будет один параграф
Первый параграф
Второй параграфmarkdownПредпросмотр:
Если не оставить пустую строку То это будет один параграф
Первый параграф
Второй параграф
Разделитель#
Если у вас привычка - ставить разделитель, то введите 3 тире --- или 3 звёздочки ***.
Оставьте пустую строку перед и после, если есть параграфы:
---markdownПредпросмотр:
Продвинутый маркдаун#
Строчные HTML элементы#
Лишь малая часть поддерживается, включая <kdb> <b> <i> <em> <sup> <sub> <br>, вот они в деле
Вывод клавиш#
Используй <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Del</kbd> для перезагрузкиmarkdownПредпросмотр:
Используй Ctrl + Alt + Del для перезагрузки
Жирный курсив#
<b> Маркдаун здесь просто _жирный_</b>markdownПредпросмотр:
Маркдаун здесь просто жирный
Другие HTML приколы#
Сворачиваемый блок#
<details><summary>Клик для показа</summary>Ку-ку</details>markdownПредпросмотр:
Клик для показа
Ку-куТаблицы#
| Заголовок1 | Заголовок2 |
| ---------- | ---------- |
| Контент | Контент2 |markdownПредпросмотр:
| Заголовок1 | Заголовок2 |
|---|---|
| Контент | Контент2 |
Сноски#
Используйте [^сноску] что добавить [^сноску2] в начала ссылки.
Затем добавьте описание сноски (она будет выведена в конце документа по умолчанию).
[^сноску]: Вот содержимое сноски
[^сноску2]: Ещё одна сноска с большим содержимымmarkdownПредпросмотр:
Используйте 1 что добавить 2 в начала ссылки.
Затем добавьте описание сноски (она будет выведена в конце документа по умолчанию).
Чек-лист списки#
- [ ] Незавершённая задача
- [x] Завершённая задачаmarkdownПредпросмотр:
- Незавершённая задача
- Завершённая задача
Экранирование символов#
Если хотите использовать эти символы _ # * можно их экранировать, добавив обратный слеш перед ним \_ \# \*
\_Этот текст не хочет быть курсивным\_
\*\*Не хочу что-бы этот текст был жирным\*\*markdownПредпросмотр:
_Этот текст не хочет быть курсивным_
**Не хочу что-бы этот текст был жирным**