Markdown
Markdown - это легкий язык разметки, который используется для форматирования текста.
Он был создан Джоном Грубером и Аароном Шварцем в 2004 году с целью создания простого и понятного способа написания веб-текстов с использованием простых символов. Markdown используется во многих платформах, включая GitHub, Reddit, Stack Overflow и многие другие.
Одна из особенностей синтаксиса Markdown заключается в том, что он не требует использования специального программного обеспечения для просмотра, поскольку любой текстовый редактор может отображать Markdown-документы в качестве форматированного текста.
Основные элементы форматирования в языке Markdown включают в себя:
Заголовки
Заголовки обозначаются с помощью символа #. В Markdown есть шесть уровней заголовков, которые обозначаются от одной до шести символов #. Например:
# Заголовок первого уровня ## Заголовок второго уровня ### Заголовок третьего уровня
Абзацы
Абзацы в Markdown создаются просто путем разделения текста пустой строкой.
По при создании абзаца, Markdown автоматически делает отступ. Чтобы начать писать с новой строки, но без отступа, используется два пробела.
Списки
Markdown поддерживает упорядоченные и неупорядоченные списки. Для создания неупорядоченного списка используйте символы *, - или +. Для упорядоченного списка используйте числа с точкой или закрывающие скобки. Например:
- Первый элемент списка
- Второй элемент списка
- Третий элемент списка
1. Первый элемент упорядоченного списка
2. Второй элемент упорядоченного списка
3. Третий элемент упорядоченного списка
Для того, чтобы создавать иерархический список необходимо использовать "Tab"
* Первый элемент списка
* Подчиненный элемент списка
* Подчиненный элемент списка
Ссылки
Ссылки в Markdown создаются, заключая текст ссылки в квадратные скобки, а URL ссылки в круглые скобки.(Пример 1) Например:
[Текст ссылки](https://softonit.ru/)
[Сайт Softonit](https://softonit.ru/ "Сайт Softonit")
Так же, можно добавить всплывающую подсказку для ссылки. Для этого, просто после URL, просто добавьте текст подсказки в кавычках. (Пример 2)
Изображения
Изображения в Markdown создаются, используя символ !, квадратные скобки для альтернативного текста изображения и круглые скобки для URL-адреса изображения. Например:
Жирный и курсивный текст
Жирный текст обозначается двумя звездочками или двумя подчеркиваниями вокруг текста, а курсивный текст обозначается одной звездочкой или одним подчеркиванием. И есть жирный курсив,который обозначается тремя звездочками или подчеркиваниями. Например:
**Жирный текст**
_Курсивный текст_
***Жирный курсив***
Зачеркнутый текст
Для создания зачеркнутой строки в языке Markdown можно использовать две тильды (~~) перед и после текста. Например:
~~Зачеркнутая строка~~
Цитаты
Цитаты в Markdown создаются с помощью символа >.
Либо, использовать 4 пробела или 2 знака табуляции.
Например:
> Это цитата.
Блок кода
Для обозначения блока кода в Markdown, код заключается в три обратных кавычки (``` ). Для оформления языка, после первых кавычек пишется расширения языка (Для 1с используется bsl)
Например:
``` bsl
&НаКлиенте
Процедура СообщениеПользователю() Экспорт
Сообщить("Привет, я процедура");
КонецПроцедуры
```
Чекбоксы
В языке Markdown можно создавать чекбоксы для списков задач или планов. Для создания чекбокса используется тире или звездочка + символ [ ] или [x], где [ ] представляет невыполненную задачу, а [x] - выполненную задачу.
Вот пример:
[ ] Задача 1
[x] Задача 2
[ ] Задача 3
Результат будет выглядеть следующим образом:
-[ ] Задача 1
-[x] Задача 2
-[ ] Задача 3
Таблицы
Для создания таблицы используются вертикальные черты (|) для разделения столбцов и дефисы (-) для разделения заголовка таблицы от содержимого.
Пример таблицы в Markdown:
|Заголовок 1|Заголовок 2|Заголовок 3|
|-------------|--------------|-------------|
| Содержимое 1| Содержимое 2 | Содержимое 3|
| Содержимое 4| Содержимое 5 | Содержимое 6|
Вы можете настроить выравнивание текста в столбцах, добавив двоеточие перед и/или после дефиса разделения заголовков и дефиса разделения содержимого. Например:
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|:-----------:|:------------:|:-----------:|
| 1 | 2 | 3 |
| 4 | 5 | 6 |
Экранирование
Markdown есть несколько символов, которые используются для форматирования текста. Если вам нужно использовать эти символы буквально, а не в качестве элементов форматирования, вы можете экранировать их с помощью обратного слэша \.
Вот список символов, которые могут требовать экранирования:
\*_{}[]<>()#+-.! |
Инлайн код
Инлайн код в языке Markdown используется для вставки фрагментов кода прямо в текстовую строку, без отображения его в виде отдельного блока или отступа. Использование инлайн кода полезно, когда вы хотите выделить отдельный кодовый термин, переменную, функцию или другой участок кода внутри обычного текста.
Для создания инлайн кода в Markdown используются обратные одинарные кавычки `console.log()`, то есть косые одинаковые символы, которые обрамляют кодовый фрагмент. Например:
Результат будет выглядеть следующим образом:
Выделенный текст
`console.log()`
