Шпаргалка по Markdown - Самые полезные структуры и форматирование

Полезное напоминание о поддерживаемых командах Markdown

Содержимое страницы

Язык разметки Markdown используется в Википедии и Hugo. Он поддерживает заголовки, списки, изменения стиля шрифта, изображения, цитаты кода и таблицы. Здесь я сохраняю краткое резюме форматирования Markdown.

файл markdown в виртуальном пространстве Это изображение выше создано Flux - AI для генерации изображений по тексту.

Markdown — это легковесный язык разметки, который можно использовать для добавления элементов форматирования в текстовые документы с обычным текстом. Это руководство предоставляет всесторонний обзор наиболее часто используемого синтаксиса Markdown, помогая вам создавать хорошо структурированные и визуально привлекательные документы.

Заголовки

Заголовки в Markdown создаются с помощью символа решетки (#). Количество решеток перед текстом заголовка указывает уровень заголовка.

# H1
## H2
### H3
#### H4
##### H5
###### H6

Выделение

Markdown предоставляет несколько способов выделения текста. Вы можете использовать звездочки (*) или подчеркивания (_) для курсива и двойные звездочки (**) или двойные подчеркивания (__) для жирного.

Курсив

*Курсив* или _курсив_

Жирный

**Жирный** или __жирный__

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

***Жирный и курсив*** или ___жирный и курсив___

Списки

Markdown поддерживает как нумерованные, так и ненумерованные списки.

Ненумерованный список

- Пункт 1
- Пункт 2
  - Подпункт 1
  - Подпункт 2

Нумерованный список

1. Первый пункт
2. Второй пункт
   1. Подпункт 1
   2. Подпункт 2

Ссылки

Ссылки создаются путем заключения текста ссылки в квадратные скобки ([]) и затем заключения URL в круглые скобки (()).

[Текст ссылки](URL)

Пример

Посетите [Руководство по Markdown](https://www.markdownguide.org/) для получения дополнительной информации.

Изображения

Изображения добавляются с помощью восклицательного знака (!), за которым следует альтернативный текст в квадратных скобках и URL изображения в круглых скобках.

![Альтернативный текст](URL изображения)

Пример

![Логотип Markdown](https://www.markdownguide.org/assets/images/markdown-logo.png)

Блочные цитаты

Блочные цитаты создаются с помощью символа больше чем (>).

> Это блочная цитата.

Вложенные блочные цитаты

> Это первый уровень цитирования.
>> Это вложенная блочная цитата.

Встроенный код и блоки кода

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

Встроенный код

Используйте `printf()` для вывода текста в C.

Блоки кода

```python
def hello_world():
    print("Hello, World!")
```

Больше о блоках кода в Markdown — см. отдельный пост: Использование блоков кода Markdown

Горизонтальные правила

Горизонтальные правила создаются с помощью трех или более тире (—), звездочек (***) или подчеркиваний (__).

---

Таблицы

Таблицы в Markdown создаются с помощью вертикальных линий (|) и тире (-).

Пример
| Заголовок 1 | Заголовок 2 |
|-------------|-------------|
| Ячейка 1    | Ячейка 2    |
| Ячейка 3    | Ячейка 4    |

Списки задач

Списки задач — это специальный тип списков, который позволяет создавать флажки.

Пример
- [x] Выполненная задача
- [ ] Незавершенная задача

Зачеркнутый текст

Зачеркнутый текст создается с помощью двойных тильд (~~).

~~Это зачеркнутый текст.~~

Выделение

Выделение текста не поддерживается нативно в Markdown, но некоторые рендереры поддерживают его с использованием синтаксиса ==.

Пример

==Это выделенный текст.==

Подстрочные и надстрочные индексы

Подстрочные индексы создаются с помощью символа caret (^) перед текстом, а надстрочные индексы — с помощью символа тильда (~) перед текстом.

Пример

H 2 O — это вода.
E = mc^2

Математические формулы

Математические формулы можно добавлять с использованием синтаксиса LaTeX внутри знаков доллара ($).

Пример

$$ E = mc^2 $$

Экранирование символов

Для экранирования специальных символов используйте обратную косую черту ().

Пример

\*Курсив\* или \_курсив\_

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

Полезные ссылки