Skip to content

docs: implement page source links via mkdocs python script

Artur Sabirov requested to merge add_page_source_link into main

Предлагаю внедрить в процесс публикации документации на сайт Picodata скрипт add_page_source_link.py. Этот скрипт добавляет в конце каждой статьи в вебе ссылку на исходный код статьи — файл формата md на GitLab. Исключение — файл index.md.

Чтобы добавить дополнительный контент на каждую страницу перед рендерингом, используется функционал хуков, которые пишутся на Python и привязываются к событиям MkDocs. В скрипте add_page_source_link.py используется событие on_page_markdown.

Предыдущая оптимизация вставки ссылок на исходный код страницы:

Merge request reports