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")
https://softonit.ru
Так же, можно добавить всплывающую подсказку для ссылки. Для этого, просто после URL, просто добавьте текст подсказки в кавычках.
Изображения
Изображения в Markdown создаются, используя символ !, квадратные скобки для альтернативного текста изображения и круглые скобки для URL-адреса изображения. Например:
Жирный и курсивный текст
Жирный текст обозначается двумя звездочками или двумя подчеркиваниями вокруг текста, а курсивный текст обозначается одной звездочкой или одним подчеркиванием. И есть жирный курсив,который обозначается тремя звездочками или подчеркиваниями. Например:
**Жирный текст**
_Курсивный текст_
***Жирный курсив***
Выделение текста
- Для создания зачеркнутой строки в языке Markdown можно использовать две тильды (~~) перед и после текста.
- Для создания выделенной желтым строки в языке Markdown можно использовать несколько подряд идущих знаков равно, два или более (==) перед и после текста.
- Для создания подчеркнутого текста в языке Markdown используется два подряд идущих знаков крышечки (^), перед и после текста.
Например:
- ~~Зачеркнутая строка~~
- ==Выделенный текст==
- ^^Подчеркнутый текст^^
Зачеркнутая строка- ==Выделенный текст==
- ^^Подчеркнутый текст^^
Подстрочные и надстрочные символы
Когда включены символы каретки и тильды, текст может быть дополнен вложенными и надстрочными знаками с помощью простого синтаксиса, что более удобно, чем прямое использование соответствующих HTML-тегов sub и sup:
Текст с вложенными и надстрочными знаками:
- H~2~O
- A^T^A
- H
2O - A^T^A
Цитаты
Цитаты в Markdown создаются с помощью символа >. Например:
> Это цитата.
Блок кода
Для обозначения блока кода в Markdown, код заключается в три обратных кавычки (```).
Для оформления языка, после первых кавычек пишется расширения языка (Для 1с используется bsl)
Например:
&НаКлиенте
Процедура СообщениеПользователю() Экспорт
Сообщить("Привет, я процедура");
КонецПроцедуры
Чекбоксы
В языке Markdown можно создавать чекбоксы для списков задач или планов. Для создания чекбокса используется тире или звездочка + символ [ ] или [x], где [ ] представляет невыполненную задачу, а [x] - выполненную задачу. Вот пример:
- Задача 1
- Задача 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 |
Вы можете настроить выравнивание текста в столбцах, добавив двоеточие перед и/или после дефиса разделения заголовков и дефиса разделения содержимого. Например:
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|:-----------:|:------------:|:-----------:|
| 1 | 2 | 3 |
| 4 | 5 | 6 |
Экранирование
Markdown есть несколько символов, которые используются для форматирования текста. Если вам нужно использовать эти символы буквально, а не в качестве элементов форматирования, вы можете экранировать их с помощью обратного слэша \.
Вот список символов, которые могут требовать экранирования:
\*_{}[]<>()#+-.! |
Inline (инлайн) код
Инлайн код в языке Markdown использует ся для вставки фрагментов кода прямо в текстовую строку, без отображения его в виде отдельного блока или отступа. Использование инлайн кода полезно, когда вы хотите выделить отдельный кодовый термин, переменную, функцию или другой участок кода внутри обычного текста.
Для создания инлайн кода в Markdown используются обратные одинарные кавычки `console.log()`, то есть косые одинаковые символы, которые обрамляют кодовый фрагмент. Например:
Результат будет выглядеть следующим образом:
Выделенный текст console.log()
Вот мы и познакомились с языком Markdown. Удачи в написании статей.
Icon (иконки)
Мы используем иконки для вставки в тексте :icon-название-иконки:, где название-иконки - это название значка Octicons.
Примеры:
:icon-alert::icon-alert::icon-star::icon-star::icon-cloud::icon-cloud:- ...
Поддерживаемые иконки
В настоящее время поддерживаются следующие значки:
| URL | Shortcode | Sample |
|---|---|---|
| URL | alert | :icon-alert: |
| URL | alert-fill | :icon-alert-fill: |
| URL | archive | :icon-archive: |
| URL | arrow-both | :icon-arrow-both: |
| URL | arrow-down | :icon-arrow-down: |
| URL | arrow-down-left | :icon-arrow-down-left: |
| URL | arrow-down-right | :icon-arrow-down-right: |
| URL | arrow-left | :icon-arrow-left: |
| URL | arrow-right | :icon-arrow-right: |
| URL | arrow-switch | :icon-arrow-switch: |
| URL | arrow-up | :icon-arrow-up: |
| URL | arrow-up-left | :icon-arrow-up-left: |
| URL | arrow-up-right | :icon-arrow-up-right: |
| URL | beaker | :icon-beaker: |
| URL | bell | :icon-bell: |
| URL | bell-fill | :icon-bell-fill: |
| URL | bell-slash | :icon-bell-slash: |
| URL | blocked | :icon-blocked: |
| URL | bold | :icon-bold: |
| URL | book | :icon-book: |
| URL | bookmark | :icon-bookmark: |
| URL | bookmark-fill | :icon-bookmark-fill: |
| URL | bookmark-slash | :icon-bookmark-slash: |
| URL | bookmark-slash-fill | :icon-bookmark-slash-fill: |
| URL | briefcase | :icon-briefcase: |
| URL | broadcast | :icon-broadcast: |
| URL | browser | :icon-browser: |
| URL | bug | :icon-bug: |
| URL | calendar | :icon-calendar: |
| URL | check | :icon-check: |
| URL | check-circle | :icon-check-circle: |
| URL | check-circle-fill | :icon-check-circle-fill: |
| URL | checkbox | :icon-checkbox: |
| URL | checklist | :icon-checklist: |
| URL | chevron-down | :icon-chevron-down: |
| URL | chevron-left | :icon-chevron-left: |
| URL | chevron-right | :icon-chevron-right: |
| URL | chevron-up | :icon-chevron-up: |
| URL | circle | :icon-circle: |
| URL | circle-slash | :icon-circle-slash: |
| URL | clock | :icon-clock: |
| URL | clock-fill | :icon-clock-fill: |
| URL | cloud | :icon-cloud: |
| URL | cloud-offline | :icon-cloud-offline: |
| URL | code | :icon-code: |
| URL | code-of-conduct | :icon-code-of-conduct: |
| URL | code-review | :icon-code-review: |
| URL | code-square | :icon-code-square: |
| URL | codescan | :icon-codescan: |
| URL | codescan-checkmark | :icon-codescan-checkmark: |
| URL | codespaces | :icon-codespaces: |
| URL | columns | :icon-columns: |
| URL | command-palette | :icon-command-palette: |
| URL | comment | :icon-comment: |
| URL | comment-discussion | :icon-comment-discussion: |
| URL | commit | :icon-commit: |
| URL | container | :icon-container: |
| URL | copilot | :icon-copilot: |
| URL | copy | :icon-copy: |
| URL | cpu | :icon-cpu: |
| URL | credit-card | :icon-credit-card: |
| URL | cross-reference | :icon-cross-reference: |
| URL | dash | :icon-dash: |
| URL | database | :icon-database: |
| URL | dependabot | :icon-dependabot: |
| URL | desktop-download | :icon-desktop-download: |
| URL | device-camera-video | :icon-device-camera-video: |
| URL | device-desktop | :icon-device-desktop: |
| URL | device-mobile | :icon-device-mobile: |
| URL | devices | :icon-devices: |
| URL | diamond | :icon-diamond: |
| URL | diff | :icon-diff: |
| URL | discussion-closed | :icon-discussion-closed: |
| URL | discussion-duplicate | :icon-discussion-duplicate: |
| URL | discussion-outdated | :icon-discussion-outdated: |
| URL | dot | :icon-dot: |
| URL | dot-fill | :icon-dot-fill: |
| URL | download | :icon-download: |
| URL | duplicate | :icon-duplicate: |
| URL | eye | :icon-eye: |
| URL | eye-closed | :icon-eye-closed: |
| URL | file | :icon-file: |
| URL | file-binary | :icon-file-binary: |
| URL | file-code | :icon-file-code: |
| URL | file-diff | :icon-file-diff: |
| URL | file-directory | :icon-file-directory: |
| URL | file-directory-fill | :icon-file-directory-fill: |
| URL | file-directory-symlink | :icon-file-directory-symlink: |
| URL | file-media | :icon-file-media: |
| URL | file-submodule | :icon-file-submodule: |
| URL | file-symlink-file | :icon-file-symlink-file: |
| URL | file-zip | :icon-file-zip: |
| URL | filter | :icon-filter: |
| URL | filter-remove | :icon-filter-remove: |
| URL | flame | :icon-flame: |
| URL | fold | :icon-fold: |
| URL | fold-down | :icon-fold-down: |
| URL | fold-up | :icon-fold-up: |
| URL | gear | :icon-gear: |
| URL | gift | :icon-gift: |
| URL | git-branch | :icon-git-branch: |
| URL | git-commit | :icon-git-commit: |
| URL | git-compare | :icon-git-compare: |
| URL | git-merge | :icon-git-merge: |
| URL | git-merge-queue | :icon-git-merge-queue: |
| URL | git-pull-request | :icon-git-pull-request: |
| URL | git-pull-request-closed | :icon-git-pull-request-closed: |
| URL | git-pull-request-draft | :icon-git-pull-request-draft: |
| URL | globe | :icon-globe: |
| URL | goal | :icon-goal: |
| URL | grabber | :icon-grabber: |
| URL | graph | :icon-graph: |
| URL | hash | :icon-hash: |
| URL | heading | :icon-heading: |
| URL | heart | :icon-heart: |
| URL | heart-fill | :icon-heart-fill: |
| URL | history | :icon-history: |
| URL | home | :icon-home: |
| URL | home-fill | :icon-home-fill: |
| URL | horizontal-rule | :icon-horizontal-rule: |
| URL | hourglass | :icon-hourglass: |
| URL | hubot | :icon-hubot: |
| URL | image | :icon-image: |
| URL | inbox | :icon-inbox: |
| URL | infinity | :icon-infinity: |
| URL | info | :icon-info: |
| URL | issue-closed | :icon-issue-closed: |
| URL | issue-draft | :icon-issue-draft: |
| URL | issue-opened | :icon-issue-opened: |
| URL | issue-reopened | :icon-issue-reopened: |
| URL | issue-tracked-by | :icon-issue-tracked-by: |
| URL | issue-tracks | :icon-issue-tracks: |
| URL | italic | :icon-italic: |
| URL | iterations | :icon-iterations: |
| URL | kebab-horizontal | :icon-kebab-horizontal: |
| URL | key | :icon-key: |
| URL | law | :icon-law: |
| URL | light-bulb | :icon-light-bulb: |
| URL | link | :icon-link: |
| URL | link-external | :icon-link-external: |
| URL | list-ordered | :icon-list-ordered: |
| URL | list-unordered | :icon-list-unordered: |
| URL | location | :icon-location: |
| URL | lock | :icon-lock: |
| URL | log | :icon-log: |
| URL | :icon-mail: | |
| URL | megaphone | :icon-megaphone: |
| URL | mention | :icon-mention: |
| URL | milestone | :icon-milestone: |
| URL | mirror | :icon-mirror: |
| URL | moon | :icon-moon: |
| URL | mortar-board | :icon-mortar-board: |
| URL | move-to-bottom | :icon-move-to-bottom: |
| URL | move-to-end | :icon-move-to-end: |
| URL | move-to-start | :icon-move-to-start: |
| URL | move-to-top | :icon-move-to-top: |
| URL | multi-select | :icon-multi-select: |
| URL | mute | :icon-mute: |
| URL | no-entry | :icon-no-entry: |
| URL | north-star | :icon-north-star: |
| URL | note | :icon-note: |
| URL | number | :icon-number: |
| URL | organization | :icon-organization: |
| URL | package | :icon-package: |
| URL | package-dependencies | :icon-package-dependencies: |
| URL | package-dependents | :icon-package-dependents: |
| URL | paper-airplane | :icon-paper-airplane: |
| URL | paperclip | :icon-paperclip: |
| URL | passkey-fill | :icon-passkey-fill: |
| URL | paste | :icon-paste: |
| URL | pencil | :icon-pencil: |
| URL | people | :icon-people: |
| URL | person | :icon-person: |
| URL | person-add | :icon-person-add: |
| URL | person-fill | :icon-person-fill: |
| URL | pin | :icon-pin: |
| URL | pin-slash | :icon-pin-slash: |
| URL | pivot-column | :icon-pivot-column: |
| URL | play | :icon-play: |
| URL | plug | :icon-plug: |
| URL | plus | :icon-plus: |
| URL | plus-circle | :icon-plus-circle: |
| URL | project | :icon-project: |
| URL | project-roadmap | :icon-project-roadmap: |
| URL | project-symlink | :icon-project-symlink: |
| URL | project-template | :icon-project-template: |
| URL | pulse | :icon-pulse: |
| URL | question | :icon-question: |
| URL | quote | :icon-quote: |
| URL | read | :icon-read: |
| URL | rel-file-path | :icon-rel-file-path: |
| URL | reply | :icon-reply: |
| URL | repo | :icon-repo: |
| URL | repo-clone | :icon-repo-clone: |
| URL | repo-forked | :icon-repo-forked: |
| URL | repo-locked | :icon-repo-locked: |
| URL | repo-pull | :icon-repo-pull: |
| URL | repo-push | :icon-repo-push: |
| URL | repo-template | :icon-repo-template: |
| URL | report | :icon-report: |
| URL | rocket | :icon-rocket: |
| URL | rows | :icon-rows: |
| URL | rss | :icon-rss: |
| URL | ruby | :icon-ruby: |
| URL | screen-full | :icon-screen-full: |
| URL | screen-normal | :icon-screen-normal: |
| URL | search | :icon-search: |
| URL | server | :icon-server: |
| URL | share | :icon-share: |
| URL | share-android | :icon-share-android: |
| URL | shield | :icon-shield: |
| URL | shield-check | :icon-shield-check: |
| URL | shield-lock | :icon-shield-lock: |
| URL | shield-slash | :icon-shield-slash: |
| URL | shield-x | :icon-shield-x: |
| URL | sidebar-collapse | :icon-sidebar-collapse: |
| URL | sidebar-expand | :icon-sidebar-expand: |
| URL | sign-in | :icon-sign-in: |
| URL | sign-out | :icon-sign-out: |
| URL | single-select | :icon-single-select: |
| URL | skip | :icon-skip: |
| URL | skip-fill | :icon-skip-fill: |
| URL | smiley | :icon-smiley: |
| URL | sort-asc | :icon-sort-asc: |
| URL | sort-desc | :icon-sort-desc: |
| URL | sponsor-tiers | :icon-sponsor-tiers: |
| URL | square | :icon-square: |
| URL | square-fill | :icon-square-fill: |
| URL | squirrel | :icon-squirrel: |
| URL | stack | :icon-stack: |
| URL | star | :icon-star: |
| URL | star-fill | :icon-star-fill: |
| URL | stop | :icon-stop: |
| URL | stopwatch | :icon-stopwatch: |
| URL | strikethrough | :icon-strikethrough: |
| URL | sun | :icon-sun: |
| URL | sync | :icon-sync: |
| URL | tab | :icon-tab: |
| URL | table | :icon-table: |
| URL | tag | :icon-tag: |
| URL | tasklist | :icon-tasklist: |
| URL | telescope | :icon-telescope: |
| URL | telescope-fill | :icon-telescope-fill: |
| URL | terminal | :icon-terminal: |
| URL | thumbsdown | :icon-thumbsdown: |
| URL | thumbsup | :icon-thumbsup: |
| URL | tools | :icon-tools: |
| URL | tracked-by-closed-completed | :icon-tracked-by-closed-completed: |
| URL | tracked-by-closed-not-planned | :icon-tracked-by-closed-not-planned: |
| URL | trash | :icon-trash: |
| URL | triangle-down | :icon-triangle-down: |
| URL | triangle-left | :icon-triangle-left: |
| URL | triangle-right | :icon-triangle-right: |
| URL | triangle-up | :icon-triangle-up: |
| URL | trophy | :icon-trophy: |
| URL | typography | :icon-typography: |
| URL | unfold | :icon-unfold: |
| URL | unlink | :icon-unlink: |
| URL | unlock | :icon-unlock: |
| URL | unmute | :icon-unmute: |
| URL | unread | :icon-unread: |
| URL | unverified | :icon-unverified: |
| URL | upload | :icon-upload: |
| URL | verified | :icon-verified: |
| URL | versions | :icon-versions: |
| URL | video | :icon-video: |
| URL | workflow | :icon-workflow: |
| URL | x | :icon-x: |
| URL | x-circle | :icon-x-circle: |
| URL | x-circle-fill | :icon-x-circle-fill: |
| URL | zap | :icon-zap: |
| URL | zoom-in | :icon-zoom-in: |
| URL | zoom-out | :icon-zoom-out: |