#material_for_mkdocs — Public Fediverse posts

Dokka for MkDocs 0.3.0 is out!

Experimentally embed Dokka output in a Material for MkDocs website, see the demo: https://opensavvy.gitlab.io/automation/dokka-material-mkdocs/docs/api/-library%20module/opensavvy.dokka.material.mkdocs.example/-example/index.html

Follow the project: https://gitlab.com/opensavvy/automation/dokka-material-mkdocs

#kotlin #dokka #gradle #material_for_mkdocs #documentation #opensource

Material for MkDocs 9.5.x — что нового в этой версии и полезные хаки при работе с документацией на нем

В декабре 23-го года Material for MkDocs обновился до версии 9.5, но из-за регрессов переходить на него многие не решились. Но сейчас версия уже достаточно стабильная и исправленная, поэтому я хотел бы поделиться с вами, что нового привнесла эта версия и какие лайфхаки я применил при переходе на эту версию при работе с документацией (и вам советую перейти также).

https://habr.com/ru/companies/hostkey/articles/800075/

#mkdocs #material_for_mkdocs #документация #релиз #написание_документации

Material for MkDocs 9.5.x — что нового в этой версии и полезные хаки при работе с документацией на нем

В декабре 23-го года Material for MkDocs обновился до версии 9.5, но из-за регрессов переходить на него многие не решились. Но сейчас версия уже достаточно стабильная и исправленная, поэтому я хотел бы поделиться с вами, что нового привнесла эта версия и какие лайфхаки я применил при переходе на эту версию при работе с документацией (и вам советую перейти также).

https://habr.com/ru/companies/hostkey/articles/800075/

#mkdocs #material_for_mkdocs #документация #релиз #написание_документации

От xWiki к static-HTML. Как мы документацию «переезжали»

Документация в компании HOSTKEY состоит из двух частей: внутренней, которая ведется и дополняется как силами наших технических писателей, так и сотрудниками отделов, для которых она предназначена, и внешней, клиентской. До недавнего времени мы и для внутренней, и для внешней документации использовали xWiki. И если для внутренней документации ее применение оправдано, то для внешней xWiki не самое оптимальное решение: внешнюю документацию создают максимум два–три человека, регистрация дополнительных пользователей не нужна, на xWiki постоянно идут атаки спам-ботов, а изменение структуры документации, переименование, масс-правки, изменение оформления и некоторые другие вещи требуют или правок непосредственно в базе данных, или достаточно много телодвижений. Из плюсов — визуальный редактор, возможность импорта/экспорта статей в формате OpenDocument и гибкая настройка прав. Поэтому было решено для внешней клиентской документации переехать на новый движок, и выбор пал на Material for MkDocs . Весь переезд у нас занял от проработки структуры и рефакторинга до непосредственно переноса и перевода части статей (английская версия отставала от русской) два месяца.

https://habr.com/ru/companies/hostkey/articles/794040/

#StaticHTML #Material_for_MkDocs #wiki #документация #документирование #база_знаний

От xWiki к static-HTML. Как мы документацию «переезжали»

Документация в компании HOSTKEY состоит из двух частей: внутренней, которая ведется и дополняется как силами наших технических писателей, так и сотрудниками отделов, для которых она предназначена, и внешней, клиентской. До недавнего времени мы и для внутренней, и для внешней документации использовали xWiki. И если для внутренней документации ее применение оправдано, то для внешней xWiki не самое оптимальное решение: внешнюю документацию создают максимум два–три человека, регистрация дополнительных пользователей не нужна, на xWiki постоянно идут атаки спам-ботов, а изменение структуры документации, переименование, масс-правки, изменение оформления и некоторые другие вещи требуют или правок непосредственно в базе данных, или достаточно много телодвижений. Из плюсов — визуальный редактор, возможность импорта/экспорта статей в формате OpenDocument и гибкая настройка прав. Поэтому было решено для внешней клиентской документации переехать на новый движок, и выбор пал на Material for MkDocs . Весь переезд у нас занял от проработки структуры и рефакторинга до непосредственно переноса и перевода части статей (английская версия отставала от русской) два месяца.

https://habr.com/ru/companies/hostkey/articles/794040/

#StaticHTML #Material_for_MkDocs #wiki #документация #документирование #база_знаний