Примеры синтакcиса Markdown


Техническая документация в компании РБ-Софт составляется в формате Markdown.

Применяется вариант синтаксиса Github, поддерживаемый проектом https://github.com/thephpleague/commonmark

Подстветка программных кодов делается компонентом https://github.com/spatie/commonmark-shiki-highlighter в который нами добавлена поддержка подсветки синтаксиса 1С.

1. Заголовки


Чтобы создать заголовок, добавьте от одного до шести символов # перед текстом заголовка. Количество #, которое вы используете, будет определять размер заголовка.

Также можно применять символы = и - для подчеркивания строки. Таким способом можно выделить заголовки первого и второго уровня.

Заголовок первого уровня выделен подчеркиванием символом =
========================================================
Заголовок второго уровня выделен подчеркиванием символом -
--------------------------------------------------------

А тут пошли заголовки при помощи символов #
# Первый уровень
## Второй уровень
### Третий уровень
#### Четвертый уровень
##### пятый уровень
###### Шестой уровень

Заголовок первого уровня выделен подчеркиванием символом =

Заголовок второго уровня выделен подчеркиванием символом -

А тут пошли заголовки при помощи символов #

Первый уровень

Второй уровень

Третий уровень

Четвертый уровень

пятый уровень
Шестой уровень

2. Шрифты


Выделение можно сделать жирным шрифтом, курсивом или зачеркнутым текстом.

2.1. Жирный

 **Выделение жирным шрифтом**

Выделение жирным шрифтом

2.2 Курсив

 *Выделение курсивом*

Выделение курсивом

2.3 Жирный и курсив

 **Жирный шрифт** и _Курсив_

Жирный шрифт и Курсив

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

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

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

3. Списки и отступы


3.1 Маркированные списки

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

Звездочка не приведет к курсивному выделению, потому что отделяется от слова пробелом.

 - Пункт 1
 - Пункт 2
    - Подпункт 2.1
    - Подпункт 2.2
  • Пункт 1
  • Пункт 2

    • Подпункт 2.1
    • Подпункт 2.2

    или

 + Пункт 1
 + Пункт 2
    + Подпункт 2.1
    + Подпункт 2.2
  • Пункт 1
  • Пункт 2

    • Подпункт 2.1
    • Подпункт 2.2

    или

 * Пункт 1
 * Пункт 2
    * Подпункт 2.1
    * Подпункт 2.2
  • Пункт 1
  • Пункт 2
    • Подпункт 2.1
    • Подпункт 2.2

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

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

Удобно, что нумерация автоматическая: можно вставить любые цифры, и ошибки не будет.

1. Пункт 1
2. Пункт 2
3. Пункт 3
  1. Пункт 1
  2. Пункт 2
  3. Пункт 3

или

1. Пункт 1
1. Пункт 2
1. Пункт 3
  1. Пункт 1
  2. Пункт 2
  3. Пункт 3

Бывают разные случаи:

1987\. Какой чудный год.

1987. Какой чудный год.

Чтобы это не превратилось в элемент списка, необходимо экранировать точку с помощью символа \. Во всех подобных случаях экранируйте синтаксис.

3.3 Многоуровневые списки (вложенные списки)

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

+Драйверы Windows для касс:
    + Для продукции Штрих-М
        - «Штрих-М: Драйвер ККТ» версии 4.14.803 и выше.
  • Драйверы Windows для касс:
    • Для продукции Штрих-М
      • «Штрих-М: Драйвер ККТ» версии 4.14.803 и выше.

3.4 Информативные списки

* __Тезис №1__

    Раскрываем тезис. Тут разместили 4 пробела перед текстом тезиса.

* __Тезис №2__

    Раскрываем тезис. Тут разместили символ табуляции перед текстом тезиса.
  • Тезис №1

    Раскрываем тезис. Тут разместили 4 пробела перед текстом тезиса.

  • Тезис №2

    Раскрываем тезис. Тут разместили символ табуляции перед текстом тезиса.

    Раскрываем тезис. Тут разместили два символа табуляции перед текстом тезиса.

3. Абзацы


Вы можете создать новый абзац,

оставив пустую строку между строками текста.

4. Программный код


Для оформления блока кода используется обратный апостроф ``` в строках перед и после кода.

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

Список основных языков для подсветки кода

  • 1c|1s
  • cmd
  • bash|shell|sh
  • powershell|psml|psdl
  • c#|cs|csharp
  • cpp
  • java
  • js|javascript
  • python
  • css
  • html
  • xml
  • json

Обозначения других языков можно просмотреть по ссылке: https://github.com/shikijs/shiki/blob/main/docs/languages.md .

Код для консоли

```cmd
yum install mc
```
yum install mc
```sh
yum install mc
```
yum install mc

Также в блок кода превращается строка, начинающаяся с 4 и более пробелов или символа табуляции.

//Тут разместили перед кодом 4 пробела
yum install mc



//А тут разместили код в строке, начинающейся с табуляции
mkdir /scripts

Код 1С

```1s
Функция ТипМаркировкиККТПоВидуПродукции(ТипМаркировкиККТИлиВидПродукции) Экспорт
  Если ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ТабачнаяПродукция") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Табак");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ОбувныеТовары") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Обувь");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Табак") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ТабачнаяПродукция");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Обувь") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ОбувныеТовары");
  Иначе
    Возврат Неопределено;
  КонецЕсли;

КонецФункции
```
Функция ТипМаркировкиККТПоВидуПродукции(ТипМаркировкиККТИлиВидПродукции) Экспорт

  Если ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ТабачнаяПродукция") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Табак");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ОбувныеТовары") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Обувь");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Табак") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ТабачнаяПродукция");
  ИначеЕсли ТипМаркировкиККТИлиВидПродукции = ПредопределенноеЗначение("Перечисление.ВидыПродукцииИС.Обувь") Тогда
    Возврат ПредопределенноеЗначение("Перечисление.ТипыМаркировкиККТ.ОбувныеТовары");
  Иначе
    Возврат Неопределено;
  КонецЕсли;

КонецФункции

Код JSON

```json
{
 "status":"success",
 "count":10,
 "isFinish":true
}
```
{
 "status":"success",
 "count":10,
 "isFinish":true
}

5. Картинки


![pic1](img/rbs-logo.png)

pic1

6. Таблицы


Вы можете создавать таблицы с переходами |и дефисами -.

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

Ячейки могут различаться по ширине и не обязательно должны быть идеально выровнены внутри столбцов.

В каждом столбце строки заголовка должно быть не менее трех дефисов.

|Первый заголовок|Второй заголовок|
|-------------|-------------|
|Ячейка содержимого|Ячейка содержимого|
|Ячейка содержимого|Ячейка содержимого|
Первый заголовок Второй заголовок
Ячейка содержимого Ячейка содержимого
Ячейка содержимого Ячейка содержимого

Вы можете использовать форматирование, такое как ссылки, встроенные блоки кода и стиль текста в вашей таблице.

|Первый заголовок|Второй заголовок|
|--- | --- |
|Ячейка содержимого|*Ячейка содержимого*|
|Ячейка содержимого|**Ячейка содержимого**|
Первый заголовок Второй заголовок
Ячейка содержимого Ячейка содержимого
Ячейка содержимого Ячейка содержимого

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

| заголовок | заголовок   | заголовок |
| :---      |     :---:   |      ---: |
| Ячейка    | Ячейка      | Ячейка    |
| Ячейка    | Ячейка      | Ячейка    |
заголовок заголовок заголовок
Ячейка Ячейка Ячейка
Ячейка Ячейка Ячейка

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

|заголовок| заголовок |
|---| ---|
|Ячейка| `|
|Ячейка| \||
заголовок заголовок
Ячейка `
Ячейка \

Можно так же вставить картинку/видео в таблицу

|Первый заголовок                 | Второй заголовок     |
| --------------------------------| ---------------------|
| [](https://youtu.be/rvFEXgnNkOY)| Ячейка содержимого
| Ячейка содержимого              |![pic1](img/rbs-logo.png) |
Первый заголовок Второй заголовок
Ячейка содержимого
Ячейка содержимого pic1

7. Сноски


Сноски будут отображены в конце документа.

Вот простая сноска[^1]. Вот более подробная сноска[^bignote].

[^1]: Это первая сноска.

[^bignote]: Вот один с несколькими абзацами и кодом.

    Сделайте отступ в абзацах, чтобы включить их в сноску.

    Добавьте столько абзацев, сколько хотите.

Вот простая сноска1. Вот более подробная сноскаbignote.

1. Это первая сноска.
bignote. Вот один с несколькими абзацами и кодом.
Сделайте отступ в абзацах, чтобы включить их в сноску.

Добавьте столько абзацев, сколько хотите.)

8. Цитаты


Вы можете отмечать текст цитаты с помощью символа >

Как говорил Авраам Линкольн:
> Прошу прощения за мой французский.

Как говорил Авраам Линкольн:

Прошу прощения за мой французский.

9. Ссылки


  • Вы можете создать встроенную ссылку, заключив текст ссылки в квадратные скобки[ ], а затем заключив URL-адрес в круглые скобки ( ).
[Заходим на сайт РБ-Софт](https://www.rbsoft.ru).

Заходим на сайт РБ-Софт.

  • Ссылка в середине предложения.

    Заходим на [сайт РБ-Софт](https://www.rbsoft.ru).
    

    Заходим на сайт РБ-Софт.

  • Ссылка в строке с квадратными скобками. Обращаем внимание, что скобки должны обязательно закрываться.

    [Заходим на сайт [РБ-Софт]](https://www.rbsoft.ru).
    

    Заходим на сайт [РБ-Софт].

  • Ссылка для картинки

    По клику на картинку будет переход на наш сайт: [![Переход_на_сайт](img/rbs-logo.png "Переход на наш сайт")](http://www.rbsoft.ru)
    

По клику на картинку будет переход на наш сайт: Переход_на_сайт

  • Строка, "похожая" на ссылку будет также преобразовываться в кликабельную ссылку.
    Заходим на сайт https://fs.rbsoft.ru/.
    

Заходим на сайт https://fs.rbsoft.ru/.

10. Горизонтальные линии (разделители)


Для того чтобы создать горизонтальную линию с использованием синтаксиса языка Markdown, необходимо поместить три (или более)дефиса или звездочки на отдельной строке текста. Между ними возможно располагать пробелы. Также можно применять символ _ . Если строка состоит из 4 и более символов подчеркивания, то вместо нее будет отображена горизонтальная линия.

Горизонтальные линии в Markdown выглядят следующим образом:

10.1. Символы *

Отрисовка линии тремя звездочками: ***
***
Следующую строку можно печатать сразу за разделителем.

Отрисовка линии тремя звездочками: *


Следующую строку можно печатать сразу за разделителем.

10.2. Символы *

Отрисовка линии тремя звездочками через пробел: * * *
* * *
Следующую строку можно печатать сразу за разделителем.

Отрисовка линии тремя звездочками через пробел: *


Следующую строку можно печатать сразу за разделителем.

10.3. Символы ---


Отрисовка линии тремя тире: ---

---

Тут важно помнить, что надо оставлять пустую строку до и после разделителя.

Отрисовка линии тремя тире: ---


Тут важно помнить, что надо оставлять пустую строку до и после разделителя.

11.1. Символы __


Отрисовка линии подчеркиванием.
______________________________
Тут пустую строку можно не оставлять.

Отрисовка линии подчеркиванием.


Тут пустую строку можно не оставлять.

12. Чекбоксы


 - [x] Выделено
 - [ ] Не выделено
  • [x] Выделено
  • [ ] Не выделено

Совпадений по запросу " "

    Совпадений по запросу "" не найдено