В комментариях к заметке о Grav подсказали очень прикольный продукт, про который я раньше не слышал – docusaurus.io. Это генератор статических сайтов, который изначально написали в Facebook. С его помощью весь контент сайта можно держать в git в формате Markdown. Я хоть и написал, что это генератор сайтов, но по факту продукт был создан конкретно под ведение документации.
Docusaurus написан на Javascript, так что установка очень простая. Ставим сначала nodejs, потом через npm запускаем docusaurus:
Всё, можно идти на 3000 порт сервера. На главной странице будут ссылки на обучение – Tutorial - Basics. Там самая база даётся с описанием того, как всё устроено. Например, если создать файл
Настройки сайта хранятся в js файлах. Чтобы их редактировать, знать js не обязательно. Если делать стандартный сайт, поменяв там иконки, цвета и т.д., то достаточно просто отредактировать существующие шаблоны.
Движок простой и удобный. Для постоянного использования нужно будет написать systemd юнит и проксировать запросы с какого-нибудь веб сервера, чтобы прикрутить TLS. Помимо документации в движке сразу реализована возможность вести блог и сделать страничку с какой-то общей информацией. То есть это может выступать как готовое решение для какого-то продукта, где есть его описание, документация и блог разработчиков. На выходе получается очень простой и быстрый html код, где ничего лишнего.
Функциональность Docusaurus расширяется плагинами. Для изменения внешнего вида есть множество готовых тем. Как я понял, это довольно популярный и зрелый продукт с большим сообществом. Так что если подбираете себе инструмент для ведения документации, обратите внимание. Его удобно загнать в git и там работать с исходниками.
⇨ Сайт / Исходники
#docs
Docusaurus написан на Javascript, так что установка очень простая. Ставим сначала nodejs, потом через npm запускаем docusaurus:
# apt install nodejs npm# npx create-docusaurus@latest my-docsite classic# cd my-docsite# npx docusaurus start --port 3000 --host 172.20.4.92Всё, можно идти на 3000 порт сервера. На главной странице будут ссылки на обучение – Tutorial - Basics. Там самая база даётся с описанием того, как всё устроено. Например, если создать файл
src/pages/page01.md, то он будет доступен по ссылке 172.20.4.92:3000/page01. То есть можно сразу писать контент. Это будет одиночная страница. В директории docs можно создавать связанные страницы с сайдбаром. Предлагаемая базовая документация как раз оформлена через docs.Настройки сайта хранятся в js файлах. Чтобы их редактировать, знать js не обязательно. Если делать стандартный сайт, поменяв там иконки, цвета и т.д., то достаточно просто отредактировать существующие шаблоны.
Движок простой и удобный. Для постоянного использования нужно будет написать systemd юнит и проксировать запросы с какого-нибудь веб сервера, чтобы прикрутить TLS. Помимо документации в движке сразу реализована возможность вести блог и сделать страничку с какой-то общей информацией. То есть это может выступать как готовое решение для какого-то продукта, где есть его описание, документация и блог разработчиков. На выходе получается очень простой и быстрый html код, где ничего лишнего.
Функциональность Docusaurus расширяется плагинами. Для изменения внешнего вида есть множество готовых тем. Как я понял, это довольно популярный и зрелый продукт с большим сообществом. Так что если подбираете себе инструмент для ведения документации, обратите внимание. Его удобно загнать в git и там работать с исходниками.
⇨ Сайт / Исходники
#docs
👍78👎4
Вчера новость прилетела от Onlyoffice, что вышла новая версия Docs 8.1. Я сначала прохладно отнёсся к ней, так как не так давно был релиз 8.0 и я о нём писал. В этот раз бегло посмотрел анонс нововведений. И меня там очень привлекло то, что они внедрили редактирование pdf файлов. Это на самом деле востребованная функциональность, так что я решил сразу её попробовать.
Про Onlyoffice я много писал на канале, есть статьи на сайте, так что не буду подробно про него рассказывать. Это сервис для совместной работы и онлайн редактирования документов. Я сам постоянно использую этот продукт в работе. Внедрил его в нескольких компаниях для работы с документами, а сам там веду документацию и некоторые другие записи совместно с другими сотрудниками.
Бесплатная версия позволяет работать одновременно над 20-ю документами в режиме редактирования. Точнее, может быть открыто не более 20-ти вкладок с документами на редактировании. Остальные будут только на чтение. Это комфортное ограничение, которое позволяет использовать продукт небольшим командам, где людей может быть сильно больше 20-ти. Ограничение только на редактирование. На практике чаще всего нужно чтение. Обновил инструкцию или документацию и закрыл. Остальные читают.
Попробовать очень просто. Даже никаких настроек не надо. Нужна только виртуалка с 8 Гб оперативной памяти и 4 vCPU. Делаем вот так:
Выбираем установку в Docker и дожидаемся завершения. После этого можно сразу идти в веб интерфейс по IP адресу сервера, создавать администратора и начинать пользоваться. Детальные настройки можно потом сделать. Для попробовать ничего делать больше не нужно. Редактор документов уже будет работать.
Я сразу закинул туда несколько pdf файлов и попробовал редактировать. Работает всё, кроме редактирования текста. Похоже на какой-то баг OCR (распознавания текста). Нажимаю Редактировать текст и документ падает с ошибкой. Помогает только закрытие и открытие документа. В логах контейнера с Docserver появляется неинформативная ошибка, так что не понятно, с чем связано. С учётом того, что релиз был вчера, думаю, что поправят.
Всё остальное нормально работает. Можно добавлять текст, вставлять картинки, различные фигуры, стрелки. Поворачивать страницы, вырезать их, добавлять новые и т.д. Прям то, что надо. Я долго себе искал бесплатный софт, чтобы просто вставлять свою подпись в pdf документы но так и не нашёл. Кстати, если кто-то знает такой, посоветуйте.
Так что рекомендую для тех, кому нужна подобная функциональность. Onlyoffice Docs может работать как в составе другого продукта этой компании Workspace, так и в интеграции со сторонними продуктами. Например, в Nextcloud. Это наиболее распространённое использование этого движка. А так он интегрируется со всеми популярными платформами для совместной работы. Есть даже плагин для Wordpress, чтобы в админке этой CMS работать с документами.
⇨ Новость о релизе / ▶️ Обзор нововведений
#onlyoffice #docs
Про Onlyoffice я много писал на канале, есть статьи на сайте, так что не буду подробно про него рассказывать. Это сервис для совместной работы и онлайн редактирования документов. Я сам постоянно использую этот продукт в работе. Внедрил его в нескольких компаниях для работы с документами, а сам там веду документацию и некоторые другие записи совместно с другими сотрудниками.
Бесплатная версия позволяет работать одновременно над 20-ю документами в режиме редактирования. Точнее, может быть открыто не более 20-ти вкладок с документами на редактировании. Остальные будут только на чтение. Это комфортное ограничение, которое позволяет использовать продукт небольшим командам, где людей может быть сильно больше 20-ти. Ограничение только на редактирование. На практике чаще всего нужно чтение. Обновил инструкцию или документацию и закрыл. Остальные читают.
Попробовать очень просто. Даже никаких настроек не надо. Нужна только виртуалка с 8 Гб оперативной памяти и 4 vCPU. Делаем вот так:
# wget https://download.onlyoffice.com/install/workspace-install.sh# bash workspace-install.shВыбираем установку в Docker и дожидаемся завершения. После этого можно сразу идти в веб интерфейс по IP адресу сервера, создавать администратора и начинать пользоваться. Детальные настройки можно потом сделать. Для попробовать ничего делать больше не нужно. Редактор документов уже будет работать.
Я сразу закинул туда несколько pdf файлов и попробовал редактировать. Работает всё, кроме редактирования текста. Похоже на какой-то баг OCR (распознавания текста). Нажимаю Редактировать текст и документ падает с ошибкой. Помогает только закрытие и открытие документа. В логах контейнера с Docserver появляется неинформативная ошибка, так что не понятно, с чем связано. С учётом того, что релиз был вчера, думаю, что поправят.
Всё остальное нормально работает. Можно добавлять текст, вставлять картинки, различные фигуры, стрелки. Поворачивать страницы, вырезать их, добавлять новые и т.д. Прям то, что надо. Я долго себе искал бесплатный софт, чтобы просто вставлять свою подпись в pdf документы но так и не нашёл. Кстати, если кто-то знает такой, посоветуйте.
Так что рекомендую для тех, кому нужна подобная функциональность. Onlyoffice Docs может работать как в составе другого продукта этой компании Workspace, так и в интеграции со сторонними продуктами. Например, в Nextcloud. Это наиболее распространённое использование этого движка. А так он интегрируется со всеми популярными платформами для совместной работы. Есть даже плагин для Wordpress, чтобы в админке этой CMS работать с документами.
⇨ Новость о релизе / ▶️ Обзор нововведений
#onlyoffice #docs
👍95👎6
Для редактирования и совместной работы с документами через браузер есть два наиболее популярных движка с открытым исходным кодом:
▪️ OnlyOffice
▪️ Collabora Online
Про #OnlyOffice я регулярно пишу, можно посмотреть материалы под соответствующим тэгом. Там же есть инструкции по быстрому запуску продукта. Решил то же самое подготовить по Collabora Online, чтобы можно было быстро их сравнить и выбрать то, что больше понравится.
Движок для редактирования документов работает в связке с каким-то другим продуктом по управлению файлами. Проще всего потестировать его в связке с ownCloud. Запускаем его:
Идём по IP адресу сервера http://10.20.1.36, создаём учётку админа и логинимся. В левом верхнем углу нажимаем на 3 полоски, раскрывая меню и переходим в раздел Market. Ставим приложение Collabora Online.
Переходим опять в консоль сервера и запускаем сервер collabora:
Возвращаемся в веб интерфейс owncloud, переходим в Настройки ⇨ Администрирование ⇨ Дополнительно. В качестве адреса сервера Collabora Online указываем http://10.20.1.36:9980. На этом всё. Можно загружать документы и открывать их с помощью Collabora Online. У меня без каких-либо проблем сразу всё заработало по этой инструкции. Работает, кстати, эта связка довольно шустро. Мне понравилось. Погонял там с десяток своих документов и таблиц.
Редактор Collabora Online сильно отличается от Onlyoffice как внешним видом, так и архитектурой. Если у Onlyoffice обработка выполняется на клиенте, что нагружает его, но снимает нагрузку с сервера, то Collabora Online всё обрабатывает на сервере. Мне кажется, это скорее плохо, чем хорошо. Ресурсов сервера потребляет в разы больше, чем Onlyoffice. Но при таком подходе надёжнее работает совместное редактирование, так как реально оно происходит на сервере, а клиентам передаётся только картинка.
Интерфейс Onlyoffice больше похож на Excel, интуитивно с ним проще работать. Основные форматы - .docx, .xlsx, .pptx. Соответственно и совместимость с ними лучше. Collabora построена на базе LibreOffice, а он заметно отличается от Excel, так что переход будет более болезненный. Основные форматы - .odt, .ods, .odp. Майкрософтовские документы открывает хуже.
Какой из этих продуктов лучше и предпочтительнее в использовании, сказать трудно. Надо тестировать самому на своём наборе документов. В целом, оба продукта уже давно на рынке, каких-то критических проблем с ними нет, люди работают. Но, разумеется, есть свои нюансы, проблемы и особенности.
#docs #fileserver
▪️ OnlyOffice
▪️ Collabora Online
Про #OnlyOffice я регулярно пишу, можно посмотреть материалы под соответствующим тэгом. Там же есть инструкции по быстрому запуску продукта. Решил то же самое подготовить по Collabora Online, чтобы можно было быстро их сравнить и выбрать то, что больше понравится.
Движок для редактирования документов работает в связке с каким-то другим продуктом по управлению файлами. Проще всего потестировать его в связке с ownCloud. Запускаем его:
# docker run -d -p 80:80 owncloudИдём по IP адресу сервера http://10.20.1.36, создаём учётку админа и логинимся. В левом верхнем углу нажимаем на 3 полоски, раскрывая меню и переходим в раздел Market. Ставим приложение Collabora Online.
Переходим опять в консоль сервера и запускаем сервер collabora:
# docker run -t -d -p 9980:9980 -e "extra_params=--o:ssl.enable=false" collabora/codeВозвращаемся в веб интерфейс owncloud, переходим в Настройки ⇨ Администрирование ⇨ Дополнительно. В качестве адреса сервера Collabora Online указываем http://10.20.1.36:9980. На этом всё. Можно загружать документы и открывать их с помощью Collabora Online. У меня без каких-либо проблем сразу всё заработало по этой инструкции. Работает, кстати, эта связка довольно шустро. Мне понравилось. Погонял там с десяток своих документов и таблиц.
Редактор Collabora Online сильно отличается от Onlyoffice как внешним видом, так и архитектурой. Если у Onlyoffice обработка выполняется на клиенте, что нагружает его, но снимает нагрузку с сервера, то Collabora Online всё обрабатывает на сервере. Мне кажется, это скорее плохо, чем хорошо. Ресурсов сервера потребляет в разы больше, чем Onlyoffice. Но при таком подходе надёжнее работает совместное редактирование, так как реально оно происходит на сервере, а клиентам передаётся только картинка.
Интерфейс Onlyoffice больше похож на Excel, интуитивно с ним проще работать. Основные форматы - .docx, .xlsx, .pptx. Соответственно и совместимость с ними лучше. Collabora построена на базе LibreOffice, а он заметно отличается от Excel, так что переход будет более болезненный. Основные форматы - .odt, .ods, .odp. Майкрософтовские документы открывает хуже.
Какой из этих продуктов лучше и предпочтительнее в использовании, сказать трудно. Надо тестировать самому на своём наборе документов. В целом, оба продукта уже давно на рынке, каких-то критических проблем с ними нет, люди работают. Но, разумеется, есть свои нюансы, проблемы и особенности.
#docs #fileserver
2👍66👎3
Вчера обновился популярный онлайн редактор документов ONLYOFFICE DocumentServer 9.0. Давно знаю и работаю с этим продуктом. Он нравится больше любого другого бесплатного аналога. Хотя аналогов особо и нет. Есть только Collabora Online на базе LibreOffice.
Изменений не сказать, что много. Самое заметное - новый интерфейс. Он существенно отличается от старого, так что можно не узнать продукт, если мельком увидеть. Появилась тёмная тема. Не уверен, что именно в этом обновлении, но раньше я не обращал на неё внимание. Ещё много обновлений на тему внедрения AI в разные места.
Для тех, кто не знает, поясню, что это за продукт и какие вопросы закрывает. У компании целая линейка различных продуктов и сразу неочевидно, какой за что отвечает.
🔹DocumentServer - непосредственно редактор документов. Он полностью open source, но есть в платной и бесплатной редакциях. Ограничение бесплатной версии - 20 одновременно открытых вкладок на редактирование. Если их превышаешь, то документ открывается только на чтение. В целом, это комфортное ограничение для небольших коллективов. Не всем и не всегда нужно открывать документы на редактирование. DocumentServer интегрируется с множеством других популярных продуктов - NextCloud, OwnCloud, есть плагин для Wordpress и многих других продуктов. Так как это open source, есть исправленные версии сервера, где ограничение снято. Я лично их не использовал, но они легко гуглятся.
🔹Workspace - портал для совместной работы, который включает в себя помимо работы с документами через DocumentServer, почтовый клиент, CRM систему, управление проектами, календарь, wiki, чат, форумы. Сам портал полностью бесплатен. Есть коммерческие версии, где в состав включены лицензии на некоторые другие продукты.
🔹Desktop Editors - полностью бесплатные десктопные редакторы документов.
🔹DocSpace - ещё один продукт на базе DocumentServer, который организует отдельные комнаты с набором документов для совместной работы. Для него тоже есть бесплатная версия, но не смог найти описание ограничений. Раньше было главное ограничение - только одна учётная запись администратора, который всем управляет. Я лично этот продукт не использовал и нигде не внедрял. Не увидел применения.
Продукты Onlyoffice - пример качественного бесплатного ПО. Он легко ставится и настраивается. Ограничения лояльные и позволяют активно им пользоваться. Поставить и попробовать продукт очень просто (но в документации всё запутано, фиг найдёшь эти ссылки):
Выбирайте установку через Docker. Скрипт
Скрипт всё сделает сам. Дальше нужно будет пойти в браузере по IP адресу сервера и выполнить начальную настройку. Всю настройку и обслуживание можно делать через веб интерфейс. В целом, там всё нормально работает. Но лично я для бэкапов пишу свои костыли на bash, не использую встроенные средства. Там необходимо скопировать непосредственно файлы (
Если ищите себе продукт для совместной работы с документами, то обязательно попробуйте Onlyoffice. На его базе работает сервис документов Яндекса. Сейчас они запустили версию beta нового интерфейса. Не знаю, на базе чего он работает. На Onlyoffice уже не похож внешне. А текущая версия точная копия 1 в 1.
❗️Если заметка вам полезна, не забудьте 👍 и забрать в закладки.
#onlyoffice #docs #управление_проектами
Изменений не сказать, что много. Самое заметное - новый интерфейс. Он существенно отличается от старого, так что можно не узнать продукт, если мельком увидеть. Появилась тёмная тема. Не уверен, что именно в этом обновлении, но раньше я не обращал на неё внимание. Ещё много обновлений на тему внедрения AI в разные места.
Для тех, кто не знает, поясню, что это за продукт и какие вопросы закрывает. У компании целая линейка различных продуктов и сразу неочевидно, какой за что отвечает.
🔹DocumentServer - непосредственно редактор документов. Он полностью open source, но есть в платной и бесплатной редакциях. Ограничение бесплатной версии - 20 одновременно открытых вкладок на редактирование. Если их превышаешь, то документ открывается только на чтение. В целом, это комфортное ограничение для небольших коллективов. Не всем и не всегда нужно открывать документы на редактирование. DocumentServer интегрируется с множеством других популярных продуктов - NextCloud, OwnCloud, есть плагин для Wordpress и многих других продуктов. Так как это open source, есть исправленные версии сервера, где ограничение снято. Я лично их не использовал, но они легко гуглятся.
🔹Workspace - портал для совместной работы, который включает в себя помимо работы с документами через DocumentServer, почтовый клиент, CRM систему, управление проектами, календарь, wiki, чат, форумы. Сам портал полностью бесплатен. Есть коммерческие версии, где в состав включены лицензии на некоторые другие продукты.
🔹Desktop Editors - полностью бесплатные десктопные редакторы документов.
🔹DocSpace - ещё один продукт на базе DocumentServer, который организует отдельные комнаты с набором документов для совместной работы. Для него тоже есть бесплатная версия, но не смог найти описание ограничений. Раньше было главное ограничение - только одна учётная запись администратора, который всем управляет. Я лично этот продукт не использовал и нигде не внедрял. Не увидел применения.
Продукты Onlyoffice - пример качественного бесплатного ПО. Он легко ставится и настраивается. Ограничения лояльные и позволяют активно им пользоваться. Поставить и попробовать продукт очень просто (но в документации всё запутано, фиг найдёшь эти ссылки):
# wget https://download.onlyoffice.com/install/workspace-install.sh# bash workspace-install.shВыбирайте установку через Docker. Скрипт
workspace-install.sh скачает ещё один скрипт для установки через Docker - http://download.onlyoffice.com/install/install.sh. В этом скрипте есть проверка на наличие 8 GB оперативной памяти и 40 GB доступного места на диске. Для тестов можно урезать осетра и вручную подправить требования по памяти до 4 GB. Стек запустится и будет неспешно работать. Для комфортной работы памяти, конечно, лучше побольше отдать. Скрипт всё сделает сам. Дальше нужно будет пойти в браузере по IP адресу сервера и выполнить начальную настройку. Всю настройку и обслуживание можно делать через веб интерфейс. В целом, там всё нормально работает. Но лично я для бэкапов пишу свои костыли на bash, не использую встроенные средства. Там необходимо скопировать непосредственно файлы (
/app/onlyoffice) и дамп базы данных.Если ищите себе продукт для совместной работы с документами, то обязательно попробуйте Onlyoffice. На его базе работает сервис документов Яндекса. Сейчас они запустили версию beta нового интерфейса. Не знаю, на базе чего он работает. На Onlyoffice уже не похож внешне. А текущая версия точная копия 1 в 1.
❗️Если заметка вам полезна, не забудьте 👍 и забрать в закладки.
#onlyoffice #docs #управление_проектами
👍144👎5
Собрал подборку из заметок на канале на тему инструментов для ведения документации. Ни разу этого не делал, а материала накопилось прилично. В списке явно прослеживаются 2 категории продуктов:
🔹классические в формате wiki;
🔹статические генераторы.
Так что список будет состоять из двух этих категорий, и в конце всё остальное, что останется, в третьей.
Wiki:
◽️DocuWIKI, MediaWiki - по ним не было отдельных заметок, но не мог пропустить эти очень старые и известные продукты. Я сам не раз составлял документацию в DocuWIKI. Это очень простая wiki-подобная панель управления документами, которая работает на php, не требует СУБД, а все заметки хранит в текстовых md файлах. Очень легко бэкапить и синхронизировать документацию.
◽️Wiki.js - современная реализация технологии wiki. Очень хорошая функциональность. Среди всех современных wiki, это самая навороченная и красивая. Там и API, и аутентификаций куча всяких, продвинутый поиск, синхронизация с git и многое другое.
◽️BookStack - ещё один движок на базе wiki, но не только. Больше похож на классическую CMS на PHP, которая в том числе поддерживает wiki. Это для любителей олдскула, хотя проект не брошен. Развивается и поддерживается. Есть аутентификация через AD.
Статические генераторы:
◽️MkDocs - как мне кажется, наиболее популярный генератор именно для документации. С его помощью написана документация для многих известных проектов. Например - Rocky Linux. Принцип там такой - пишите документация в формате md, хранить можно в git. Отдельно пишите инструкцию по генерации сайта в формате yaml. И после каждого обновления контента запускаете генерацию новых страничек или всего сайта.
◽️Hugo - это в целом самый популярный генератор статических сайтов, который в том числе используют для документации, но вообще он для сайтов общего назначения. Многие техноблогеры используют этот движок для своих блогов.
◽️Antora - продвинутый инструмент для ведения документации профессиональными техническими писателями. Там есть деление на продукты, вертки, версии. Управление документацией ведётся по принципу docs as code.
◽️Grav - универсальная CMS, которая в том числе подходит для хранения документации. У неё есть отдельная тема для синхронизации контента с git репозиторием. Сама CMS вместе с markdown редактором работает на PHP. Это может быть удобно, если хочется писать текст во встроенном редакторе, а не где-то на стороне.
◽️Docusaurus - ещё один статический генератор, который изначально был заточен под ведение документации и написан в Facebook. У него простой, лаконичный дизайн, интеграция с git, документы хранит в формате md. Написан на Go, расширяется плагинами. Нормальное современное решение для простой документации.
Разное:
◽️Onlyoffice - это целый портал для совместной работы, который включает в том числе отдельный раздел для wiki. Но лично мне нравится в нём вести текстовую документацию в формате обычных документов docx и xlsx с общим доступом к файлам. Это в целом удобно, так как хранится наглядная история версий, можно скачать файл локально, куда-то переслать, поработать с ним на компе в десктопном редакторе.
Перечислил то, что знал и частично использовал. Если у вас есть ещё рекомендации бесплатных продуктов для ведения документации, поделитесь в комментариях.
❗️Если заметка вам полезна, не забудьте 👍 и забрать в закладки.
#wiki #docs #подборка
🔹классические в формате wiki;
🔹статические генераторы.
Так что список будет состоять из двух этих категорий, и в конце всё остальное, что останется, в третьей.
Wiki:
◽️DocuWIKI, MediaWiki - по ним не было отдельных заметок, но не мог пропустить эти очень старые и известные продукты. Я сам не раз составлял документацию в DocuWIKI. Это очень простая wiki-подобная панель управления документами, которая работает на php, не требует СУБД, а все заметки хранит в текстовых md файлах. Очень легко бэкапить и синхронизировать документацию.
◽️Wiki.js - современная реализация технологии wiki. Очень хорошая функциональность. Среди всех современных wiki, это самая навороченная и красивая. Там и API, и аутентификаций куча всяких, продвинутый поиск, синхронизация с git и многое другое.
◽️BookStack - ещё один движок на базе wiki, но не только. Больше похож на классическую CMS на PHP, которая в том числе поддерживает wiki. Это для любителей олдскула, хотя проект не брошен. Развивается и поддерживается. Есть аутентификация через AD.
Статические генераторы:
◽️MkDocs - как мне кажется, наиболее популярный генератор именно для документации. С его помощью написана документация для многих известных проектов. Например - Rocky Linux. Принцип там такой - пишите документация в формате md, хранить можно в git. Отдельно пишите инструкцию по генерации сайта в формате yaml. И после каждого обновления контента запускаете генерацию новых страничек или всего сайта.
◽️Hugo - это в целом самый популярный генератор статических сайтов, который в том числе используют для документации, но вообще он для сайтов общего назначения. Многие техноблогеры используют этот движок для своих блогов.
◽️Antora - продвинутый инструмент для ведения документации профессиональными техническими писателями. Там есть деление на продукты, вертки, версии. Управление документацией ведётся по принципу docs as code.
◽️Grav - универсальная CMS, которая в том числе подходит для хранения документации. У неё есть отдельная тема для синхронизации контента с git репозиторием. Сама CMS вместе с markdown редактором работает на PHP. Это может быть удобно, если хочется писать текст во встроенном редакторе, а не где-то на стороне.
◽️Docusaurus - ещё один статический генератор, который изначально был заточен под ведение документации и написан в Facebook. У него простой, лаконичный дизайн, интеграция с git, документы хранит в формате md. Написан на Go, расширяется плагинами. Нормальное современное решение для простой документации.
Разное:
◽️Onlyoffice - это целый портал для совместной работы, который включает в том числе отдельный раздел для wiki. Но лично мне нравится в нём вести текстовую документацию в формате обычных документов docx и xlsx с общим доступом к файлам. Это в целом удобно, так как хранится наглядная история версий, можно скачать файл локально, куда-то переслать, поработать с ним на компе в десктопном редакторе.
Перечислил то, что знал и частично использовал. Если у вас есть ещё рекомендации бесплатных продуктов для ведения документации, поделитесь в комментариях.
❗️Если заметка вам полезна, не забудьте 👍 и забрать в закладки.
#wiki #docs #подборка
2👍105👎2