Чек-лист добавления новой статьи¶

Файлы¶

Все статьи размещаются в подкаталоге docs.
Статья размещается в предсказуемом и логичном месте.
Имя файла: <ИмяСтатьиЛатиницей>.md.
Все дополнительные файлы - изображения, файлы для скачивания итп, размещаются в каталоге <ИмяСтатьиЛатиницей>.assets.
Пустых каталогов быть не должно. Файлы .gitkeep запрещены.

Контент¶

Статья начинается с заголовка # Заголовок статьи. По этому заголовку формируется имя статьи на панели навигации.
Все внутренние ссылки в статье должны быть указаны на конкретные файлы *.md.
Все внутренние ссылки должны быть относительными - без указания полного пути и в начале не должно быть слеша /.
Все пути в ссылках указаны с прямыми слешами /. Чтобы не путаться - слеши должны быть такими же, как и в адресной строке браузера.

Дополнительные возможности в оформлении¶

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

Оформление блоков кода

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

Примеры оформления блоков https://squidfunk.github.io/mkdocs-material/extensions/admonition/

Пример блока

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Примеры оформления блоков кода https://squidfunk.github.io/mkdocs-material/extensions/codehilite/

ДобавитьОтбор

// Добавляет отбор в группу отбора условного оформления
//
// Параметры:
//  пУО    - ЭлементУсловногоОформленияКомпоновкиДанных  - Элемент условного оформления
//  ПутьКДаннымПоля        - Строка - путь к данным поля
//  пЗначение            - Любое - значение отбора
//  ВидСравнения        - ВидСравненияКомпоновкиДанных - вид сравнения.
//
// Возвращаемое значение:
//  ОбщийМодуль - этот модуль
Функция ДобавитьОтбор( пУО, Знач ПутьКДаннымПоля, Знач пЗначение, Знач ВидСравнения = Неопределено ) Экспорт

    Если ВидСравнения = Неопределено Тогда

        ВидСравнения = ВидСравненияКомпоновкиДанных.Равно;

    КонецЕсли;

    Отбор                = пУО.Отбор.Элементы.Добавить( Тип( "ЭлементОтбораКомпоновкиДанных" ) );
    Отбор.ВидСравнения   = ВидСравнения;
    Отбор.Использование  = Истина;
    Отбор.ЛевоеЗначение  = Новый ПолеКомпоновкиДанных( ПутьКДаннымПоля );
    Отбор.ПравоеЗначение = пЗначение;

    Возврат к2УО;

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

Отбор_Заполнено

// Добавляет отбор на заполнение поля в группу отбора условного оформления
//
// Параметры:
//  пУО    - ЭлементУсловногоОформленияКомпоновкиДанных  - Элемент условного оформления
//  ПутьКДаннымПоля - Строка - путь к данным поля.
//
// Возвращаемое значение:
//  ОбщийМодуль - этот модуль
Функция Отбор_Заполнено( пУО, Знач ПутьКДаннымПоля ) Экспорт

    ДобавитьОтбор( пУО, ПутьКДаннымПоля, , ВидСравненияКомпоновкиДанных.Заполнено );

    Возврат к2УО;

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

Равенство полей

// Добавляет отбор в группу отбора условного оформления
//
// Параметры:
//  пУО    - ЭлементУсловногоОформленияКомпоновкиДанных  - Элемент условного оформления
//  ПутьКДаннымЛевогоПоля - Строка - путь к данным поля
//  ПутьКДаннымПравогоПоля - Строка - путь к данным поля.
//
// Возвращаемое значение:
//  ОбщийМодуль - этот модуль
Функция Отбор_РавенствоПолей( пУО, Знач ПутьКДаннымЛевогоПоля, Знач ПутьКДаннымПравогоПоля ) Экспорт

    ДобавитьОтбор( пУО, ПутьКДаннымЛевогоПоля, Новый ПолеКомпоновкиДанных( ПутьКДаннымПравогоПоля ), ВидСравненияКомпоновкиДанных.Равно );

    Возврат к2УО;

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

Файл `.page`

С помощью этих файлов можно задавать имя каталогу, сортировать статьи, настраивать навигацию, включать/выключать скрытие для одного файла или скрывать каталог в целом. Подробнее: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

Например, файл этого раздела означает, что раздел называется Знания, а сортировка - файл index.md, потом каталог Posts, потом Certification, а дальше в алфавитном порядке:

title: Знания
arrange:
    - index.md
    - Posts
    - Certification
    - ...

Последнее обновление: 3 января 2021 г.