Markdown-справочник

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

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

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

markdown-file в пространстве Это изображение выше создано 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 создаются с использованием трубочек (|) и тире (-).

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

Списки задач

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

Пример
- [x] Завершенная задача
- [ ] Незавершенная задача

Зачеркивание

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

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

Выделение

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

Пример

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

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

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

Пример

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

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

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

Пример

$$ E = mc^2 $$

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

Чтобы экранировать специальные символы, используйте обратный слеш ().

Пример

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

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

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