file-linesMarkdown

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

Основные элементы синтаксиса Markdown

Заголовки

Заголовки создаются с помощью символа #. Чем больше символов #, тем ниже уровень заголовка.

# Заголовок 1
## Заголовок 2
### Заголовок 3

Результат:

Заголовок 1

Заголовок 2

Заголовок 3

Форматирование текста

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

  • Полужирный: используйте **текст** или __текст__

  • Курсив: используйте *текст* или _текст_

  • Зачёркнутый: используйте ~~текст~~

Результат:

Полужирный текст Курсивный текст Зачёркнутый текст

Списки

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

Маркированный список:

Результат:

  • Элемент 1

  • Элемент 2

    • Подэлемент

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

Результат:

  1. Первый элемент

  2. Второй элемент

    1. Подэлемент

Ссылки и изображения

Markdown упрощает вставку ссылок и изображений.

  • Ссылки: [текст ссылки](URL)

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

Результат:

Перейти на Googlearrow-up-right

Блоки кода и выделение кода

Код можно выделить как внутри текста, так и отдельным блоком.

  • Встроенное выделение: используйте `код`

  • Блок кода: используйте тройные обратные кавычки (```) перед и после блока кода.

Результат:

Пример встроенного выделения: код

Пример блока кода:

Цитаты

Цитаты создаются с помощью символа >.

Результат:

Это пример цитаты. Она может занимать несколько строк.

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

Чтобы разделить содержимое, можно вставить горизонтальную линию, используя три или больше тире (---), подчеркивания (___), или звездочки (***).

Результат:


Пример использования Markdown для создания документации

Markdown отлично подходит для создания документации благодаря его читабельности и легкости форматирования. Вот пример простого руководства с использованием Markdown:

Last updated