Skip to content

chore: add comments to mkdocs.yml

Artur Sabirov requested to merge add_comments_to_mkdocs_yml into main

Задача

Описать и снабдить ссылками настройки в файле mkdocs.yml.

Решение

Первый коммит

Изменения в файле mkdocs.yml:

  • из группы features удалены настройки navigation.indexes, navigation.path
  • из группы markdown_extensions удалены настройки md_in_html, meta, toc

See:

Второй коммит

Изменения в файле mkdocs.yml:

  • добавлены описания и ссылки практически ко всем настройкам и группам настроек

Не нашел ссылку на описание настройки logo_mobile, но в нашей конфигурации она работает.

Коммиты

  • mkdocs.yml: delete deprecated settings
  • chore: add comments to mkdocs.yml

Close #138 (closed)

Staging: https://docs.binary.picodata.io/picodata/branch-add_comments_to_mkdocs_yml/

Саморевью

  • Контент отображается корректно
  • Ссылки в контенте работоспособны и корректны
Edited by Artur Sabirov

Merge request reports