Базовый синтаксис Markdown для оформления материалов.

Markdown — это облегчённый язык разметки, который преобразует текст в структурированный HTML. Следующее руководство поможет вам разобраться, как использовать Markdown.

Заголовки

В синтаксисе Markdown предусмотрено шесть уровней заголовков: H1 — самый крупный, H6 — самый мелкий. Чтобы обозначить уровень заголовка, используются символ #. При этом есть некоторые особенности:

Символ «решётка» должен стоять только перед заголовком;
Количество символов «решётка» указывает на уровень заголовка: одна решётка для первого уровня, две — для второго и так далее;
Между символа «решётка» и текстом должен быть пробел.

Разметка

# Заголовок первого уровня

## Заголовок второго уровня

### Заголовок третьего уровня

#### Заголовок четвёртого уровня

##### Заголовок пятого уровня

###### Заголовок шестого уровня

Результат

# Заголовок первого уровня (h1)
## Заголовок второго уровня (h2)
### Заголовок третьего уровня (h3)
#### Заголовок четвёртого уровня (h4)
##### Заголовок пятого уровня (h5)
###### Заголовок шестого уровня (h6)

Параграфы и переносы строк

Чтобы разделить текст на абзацы, необходимо оставить пустую строку между ними. Даже если в строке есть пробелы или табуляции, она всё равно будет считаться пустой. Если же строки расположены рядом, они автоматически объединяются в один параграф.

Для переноса строки внутри одного параграфа используется используется символ \.

Разметка

Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.

Это первая строка \
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте символ `\` в конце предыдущей строки.

Результат

Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.

Это первая строка
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте символ \ в конце предыдущей строки.

Выделение текста

Чтобы изменить начертание текста, нужно заключить его в специальные символы с двух сторон: <символ>текст<символ>:

Для выделения текста курсивом нужно использовать одну звёздочку *;
Для выделения текста жирным нужно использовать две звёздочки **;
Для выделения текста сразу курсивом и жирным нужно использовать три звёздочки ***;
Чтобы зачеркнуть текст, нужно использовать две тильды ~~.

Разметка

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

Одним из таких стартапов является компания _НейроКод_, которая разрабатывает уникальные алгоритмы машинного обучения. Их последняя разработка, система **_Умный Ассистент_**, способна анализировать огромные массивы данных и предлагать пользователю персонализированные решения в реальном времени. Представьте себе, что ваш смартфон не просто помощник, а настоящий виртуальный консультант, который знает о вас больше, чем ваша собственная тень.

Результат:

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

Одним из таких стартапов является компания НейроКод, которая разрабатывает уникальные алгоритмы машинного обучения. Их последняя разработка, система Умный Ассистент, способна анализировать огромные массивы данных и предлагать пользователю персонализированные решения в реальном времени. Представьте себе, что ваш смартфон не просто помощник, а настоящий виртуальный консультант, который знает о вас больше, чем ваша собственная тень.

Списки

В синтаксисе Markdown существует несколько видов списков. Чтобы их создать, необходимо перед каждым пунктом поставить соответствующий символ и отделить его от остального текста пробелом.

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

Разметка

1. Пункт первый
2. Пункт второй
3. Пункт третий

Результат

Пункт первый
Пункт второй
Пункт третий

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

Разметка

- Пункт первый
- Пункт второй
- Пункт третий

Результат

Пункт первый
Пункт второй
Пункт третий

Вложенные списки

Для разметки вложенных списков, добавляя 4 пробела (знак табуляции) перед пунктом:

Разметка

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

Результат

Пункт первый
- Подпункт первый
- Подпункт второй
Пункт второй

Список задач

Для разметки списка задач, необходимо использовать маркированный список, но между маркером и текстом поставить [x] для отмеченного пункта и [ ] — для неотмеченного.

Разметка

- [x] Задача 1
- [ ] Задача 2
- [ ] Задача 3

Результат

Задача 1
Задача 2
Задача 3

Ссылки

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

Разметка

[Текст ссылки](https://www.example.com)

Результат:

Текст ссылки

Использование атрибута `title`

При необходимости вы можете добавить заголовок к ссылке. Он будет отображаться как всплывающая подсказка, когда пользователь наведёт курсор на ссылку. Чтобы добавить заголовок, нужно заключить его в кавычки сразу после URL-адреса.

Разметка

[Текст ссылки](https://www.example.com 'Заголовок ссылки')

Результат

Текст ссылки

Безанкорные ссылки

Чтобы быстро преобразовать URL-адрес или адрес электронной почты в ссылку, необходимо заключить строку в угловые скобки.

Разметка

<https://www.altmoble.org>
<name@example.com>

Результат

https://www.altmoble.org
fake@example.com

Изображение

Изображения в Markdown оформляются по принципу, схожему с принципом оформления ссылок, только перед квадратными скобками нужно поставить восклицательный знак: ![текст](путь к изображению). Здесь также можно сделать всплывающую подсказку. Аналогичным образом добавляются подсказки в формате ![текст](изображение 'подсказка')

Результат

Таблицы

Разметка таблиц в формате Markdown: столбцы разделяются вертикальными линиями |, а строка с шапкой отделяется от остальных дефисами -, которых можно ставить сколько угодно:

Разметка

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
| ----------- | ----------- | ----------- |
| Ячейка 1    | Ячейка 2    | Ячейка 5    |
| Ячейка 3    | Ячейка 4    | Ячейка 6    |

Результат

Заголовок 1	Заголовок 2	Заголовок 3
Ячейка 1	Ячейка 2	Ячейка 5
Ячейка 3	Ячейка 4	Ячейка 6

Чтобы выровнять весь столбец по правому краю, нужно поставить двоеточие после разделителя. Если нужно выровнять содержимое по центру, двоеточия следует поставить с обеих сторон.

Разметка

| Заголовок 1 | Заголовок 2 | Заголовок 3 |
| ----------- | :---------: | ----------: |
| Ячейка 1    |  Ячейка 2   |    Ячейка 5 |
| Ячейка 3    |  Ячейка 4   |    Ячейка 6 |

Результат

Заголовок 1	Заголовок 2	Заголовок 3
Ячейка 1	Ячейка 2	Ячейка 5
Ячейка 3	Ячейка 4	Ячейка 6

Цитаты

Чтобы параграф отобразился как цитата, нужно поставить перед ним закрывающую угловую скобку >.

Разметка

> Phosh – это графическое рабочее окружение, разработанное специально для мобильных и сенсорных устройств. Оно используется в нескольких мобильных операционных системах на базе Linux, включая PureOS, Mobian и Fedora Phosh, а также доступно как опция в postmarketOS, Manjaro и openSUSE. Phosh был создан компанией Purism и впервые выпущен в октябре 2018 года.

Результат

Phosh – это графическое рабочее окружение, разработанное специально для мобильных и сенсорных устройств. Оно используется в нескольких мобильных операционных системах на базе Linux, включая PureOS, Mobian и Fedora Phosh, а также доступно как опция в postmarketOS, Manjaro и openSUSE. Phosh был создан компанией Purism и впервые выпущен в октябре 2018 года.

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

Разметка

> Проект ALT Mobile представляет собой инициативу по созданию мобильной системы на базе свободного программного обеспечения (СПО), которая стремится предоставить альтернативу традиционным мобильным операционным системам. Основная цель проекта — разработка мобильной системы, которая будет полностью контролироваться пользователем, с возможностью использования современного телефона без необходимости в проприетарных программах.

Проект базируется на репозитории «Sisyphus» и уже продемонстрировал свою работу на смартфонах PinePhone Pro, устройствах на базе СнК «Скиф», а также на компьютерах с архитектурами `x86_64`, `aarch64` и `riscv`. Для графического окружения была выбрана оболочка Phosh, основанная на библиотеках GNOME Shell, что обеспечивает совместимость и удобство использования.

> > Базовые приложения, такие как контакты, СМС и другие, адаптированы под размер и положение экрана устройства. Также были адаптированы несколько приложений для связи, воспроизведения аудио и видео, установлены веб-браузеры Chromium и Firefox, карты, календарь, калькулятор и другие полезные утилиты. Предусмотрена возможность запуска Android-приложений через контейнер Waydroid.
> >
> > > Проект ALT Mobile демонстрирует стремление к созданию открытой и свободной альтернативы традиционным мобильным операционным системам, предоставляя пользователям полный контроль над их устройствами и приложениями.

Результат

Проект ALT Mobile представляет собой инициативу по созданию мобильной системы на базе свободного программного обеспечения (СПО), которая стремится предоставить альтернативу традиционным мобильным операционным системам. Основная цель проекта — разработка мобильной системы, которая будет полностью контролироваться пользователем, с возможностью использования современного телефона без необходимости в проприетарных программах.

Проект базируется на репозитории «Sisyphus» и уже продемонстрировал свою работу на смартфонах PinePhone Pro, устройствах на базе СнК «Скиф», а также на компьютерах с архитектурами x86_64, aarch64 и riscv. Для графического окружения была выбрана оболочка Phosh, основанная на библиотеках GNOME Shell, что обеспечивает совместимость и удобство использования.

Базовые приложения, такие как контакты, СМС и другие, адаптированы под размер и положение экрана устройства. Также были адаптированы несколько приложений для связи, воспроизведения аудио и видео, установлены веб-браузеры Chromium и Firefox, карты, календарь, калькулятор и другие полезные утилиты. Предусмотрена возможность запуска Android-приложений через контейнер Waydroid.
Проект ALT Mobile демонстрирует стремление к созданию открытой и свободной альтернативы традиционным мобильным операционным системам, предоставляя пользователям полный контроль над их устройствами и приложениями.

Блоки кода

Для выделения фрагментов кода или команд используется символ гравис (`). На клавиатуре он расположен в том же месте, что символ тильда ~ и буква «ё». Текст, заключённый в данные символы, будет выделен цветом, а также моноширинным написанием

Разметка

Команда `git status` используется для отображения списка всех изменений, ещё не добавленных в индекс Git.

Результат

Команда git status используется для отображения списка всех изменений, ещё не добавленных в индекс Git.

Чтобы выделить код в отдельный блок, обратитесь к рекомендациям на странице «Возможности VitePress».

Игнорирование форматирования Markdown

При разметке текста можно указать, что нужно игнорировать (экранировать) форматирование с помощью обратного слэша (\) перед символом Markdown.

Разметка

Проект \*ALT Mobile\* является инициативой сообщества.

Результат

Проект *ALT Mobile* является инициативой сообщества.

Символы, которые можно экранировать

Вы можете использовать обратный слэш для экранирования следующих символов:

Символ	Имя
`\`	обратная косая черта
`*`	звёздочка
`_`	нижнее подчёркивание
`{ }`	фигурные скобки
`[ ]`	квадратные скобки
`< >`	угловые скобки
`( )`	круглые скобки
`#`	решётка
`+`	плюс
`-`	минус
`.`	точка
`!`	восклицательный знак
`\|`	вертикальная черта

Авторы

x1z53

Олег Щавелев

История изменений

Последнее редактирование больше 1 года назад

Показать историю

Базовый синтаксис Markdown для оформления материалов. ​

Заголовки ​

Параграфы и переносы строк ​

Выделение текста ​

Списки ​

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

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

Вложенные списки ​

Список задач ​

Ссылки ​

Использование атрибута title ​

Безанкорные ссылки ​

Изображение ​

Таблицы ​

Цитаты ​

Блоки кода ​

Игнорирование форматирования Markdown ​

Символы, которые можно экранировать ​

Авторы

История изменений

Базовый синтаксис Markdown для оформления материалов.

Заголовки

Параграфы и переносы строк

Выделение текста

Списки

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

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

Вложенные списки

Список задач

Ссылки

Использование атрибута `title`

Безанкорные ссылки

Изображение

Таблицы

Цитаты

Блоки кода

Игнорирование форматирования Markdown

Символы, которые можно экранировать