L<Анонс|https://podlite.org/a5ZK1> практического кейса использования движка для публикации базы знаний не привлек значительного внимания.


picture

Возможно, для стороннего пользователя L<"Raku knowledge base"|https://raku-knowledge-base.podlite.org/> выглядит как ещё один сайт о малоизвестном языке программирования с непонятными текстами.


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


Были исправлены несколько ошибок в обработке Markdown-файлов, добавлена подсветка блоков с кодом, а также функции, которые будут использоваться в инструментах командной строки. Пара багов всё ещё требует детального анализа.


Впервые мне удалось создать статический сайт размером 6.5 Гб (в сжатом виде — около 800 Мб), состоящий из более чем 7000 страниц.


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


para

root

Хотя я уже давно использую Podlite ежедневно, даже не догадывался, что форматирование в таблицах C<=markdown> не работает. На это мне любезно указали в issue, и теперь всё исправлено!


Экспериментирую с фирменным стилем L<Podlite|https://podlite.org>.


По движку публикации базы знаний в Web L<podlite-web| https://github.com/podlite/podlite-web> из набора файлов есть хороший прогресс в развитии.  Он заключается в том, что сейчас можно не только публиковать свою базу знаний из набора статических файлов используя единый шаблон, но и расширять функционал создаваемых web сайтов с помощью плагинов и подключаемых внешних javascript библиотек.


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


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


Например давно хотелось  сделать предметный указатель по базе знаний (он же, если я не ошибаюсь - C<Index of Terms>). Я понимал, что это не тоже самое что предметный указатель для книги, где есть нумерация страниц, и возможно будет несколько попыток, пока не получиться удовлетворительный результат.


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


Таким образом список требований к результату был более менее конкретизирован.


В качестве практической задачи я взял идею построения базы знаний для L<Raku|https://raku.org> комьюнити на основе проектов, разбросанных по разным репозиториям - официальной документации, проекту примеров кода, а также всех пользовательских библиотек/модулей.


Заодно это был хороший повод реализовать предметный указатель, попробовать сделать поиск и протестировать парсер Podlite на предмет обработки как файлов, содержащих только разметку, так и извлечения разметки из файлов с программным кодом. 


Поскольку Podlite поддерживает markdown, то в базу знаний попали также все дополнительные файлы, сопровождающие программный код. Например, множество C<README.md> из GitHub-репозиториев пользовательских модулей, в которых тоже содержится документация.


Получившийся в итоге результат базы знаний можно посмотреть здесь: L<The Raku Knowledge Base|https://raku-knowledge-base.podlite.org/>. 
Исходники: L<
https://github.com/zag/raku-knowledge-base>


L<Предметный указатель|https://raku-knowledge-base.podlite.org/indexterms> ( Index of Terms) получился вот таким:


Вместо номеров страниц используется символ C<#>, а если для указанного Term есть несколько ссылок, то порядковые номера ссылок. При наведении курсора на ссылку отображается название документа, чтобы понять контекст, где этот термин используется.


Также поддерживается "See Also" - это когда для термина существует синоним, т.е. эта же сущность имеет другое название.


Реализована группировка терминов:


Поиск вызывается сочетанием клавиш (ctrl-K ) на любой странице: 


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


В результате в проекте публикации базы знаний из набора файлов L<podlite-web| https://github.com/podlite/podlite-web> добавились плагины для дополнительной обработки документов и возможность подключения внешних библиотек.


Также оставлю ссылку на пост из блога Podlite с подробностями: L<podlite.org/a5ZK1|https://podlite.org/a5ZK1>
