Open-source база знаний на базе LLM для документации, FAQ и блогов с ИИ-помощью в написании, ответами на вопросы и поиском.
10,5 тыс.+36 за неделю1 тыс.TypeScriptAGPL-3.0Обновлён 3 дня назад
star7th/showdoc
ShowDoc — self-hosted инструмент для документации IT-команд: API, словарей данных и командных wiki на Markdown.
Open source альтернатива:Confluence
Notion
- Звёзды
- 12,871
- Форки
- 2,212
- Открытые issues
- 235
- Последний коммит
- 18 часов назад
Что это?
ShowDoc — веб-инструмент для обмена документацией, созданный для команд разработчиков. Он решает распространённую проблему: другим сложно разобраться в коде, если его автор не оставил актуальную документацию, а документы, разбросанные по файлам Word и перепискам, быстро устаревают.
ShowDoc используют для документации API — страницы интерфейсов можно быстро создавать по шаблонам, — словарей данных с описанием полей базы данных, а также общих пояснительных документов и технических спецификаций. Страницы пишутся на Markdown, а история версий позволяет восстановить предыдущие варианты. Проекты можно сделать публичными или приватными, передать другому владельцу, открыть участникам команды и экспортировать в документы Word для работы офлайн.
ShowDoc можно развернуть на собственном сервере. В документации проекта есть руководство по установке и рекомендации по усилению безопасности для пользователей Nginx и Apache.
Ключевые возможности
- 01Встроенные шаблоны интерфейсов API и словарей данных для быстрого создания страниц.
- 02Редактор Markdown с историей версий для каждой страницы.
- 03Публичные и приватные проекты, управление участниками и передача прав владельца.
- 04Адаптивный интерфейс для чтения на компьютерах и мобильных устройствах.
- 05Экспорт проектов в документы Word для работы офлайн.
- 06Возможность развернуть на собственном сервере.
Сценарии использования
- Документировать backend API, чтобы frontend- и мобильные разработчики могли с ними работать.
- Вести словарь данных базы, описывающий каждое поле.
- Готовить инструкции по внутренним инструментам или технические спецификации для команды.
- Принимать в работу legacy-проект без письменной документации.
Быстрый старт
- 1
Разверните проект на собственном сервере, следуя руководству AutoInstall
Что важно знать
- Необходимо самостоятельно размещать проект на сервере. При использовании Nginx или Apache в целях безопасности нужно запретить доступ к каталогу Sqlite/.
- В метаданных лицензия указана как NOASSERTION, а README содержит дополнительные условия авторского права помимо Apache 2.0, требующие сохранять уведомления об авторских правах и ссылки в интерфейсе.
В подборках
Темы
Частые вопросы
- Что такое showdoc?
- ShowDoc — self-hosted инструмент для документации IT-команд: API, словарей данных и командных wiki на Markdown. ShowDoc — веб-инструмент для обмена документацией, созданный для команд разработчиков. Он решает распространённую проблему: другим сложно разобраться в коде, если его автор не оставил актуальную документацию, а документы, разбросанные по файлам Word и перепискам, быстро устаревают.
- showdoc можно использовать бесплатно? Какая у него лицензия?
- showdoc распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- showdoc всё ещё поддерживается?
- Активно поддерживается. Последний коммит в showdoc — 7 нояб. 2026 г..
- Для чего можно использовать showdoc?
- Документировать backend API, чтобы frontend- и мобильные разработчики могли с ними работать. Вести словарь данных базы, описывающий каждое поле. Готовить инструкции по внутренним инструментам или технические спецификации для команды. Принимать в работу legacy-проект без письменной документации.
- Как установить showdoc?
- Разверните проект на собственном сервере, следуя руководству AutoInstall
- Где скачать showdoc?
- Исходный код и инструкции по установке — на GitHub: https://github.com/star7th/showdoc
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Открытая платформа для совместной работы с вики и документацией — альтернатива Confluence и Notion, которую можно развернуть на собственном сервере.
22,3 тыс.+77 за неделю1,7 тыс.TypeScriptAGPL-3.0Активно поддерживаетсяОбновлён 2 часа назад
Самостоятельно размещаемая вики в виде одного Go-бинарника, с SQLite и Markdown-файлами на диске — без внешней базы данных.
1,2 тыс.+10 за неделю102GoMITАктивно поддерживаетсяОбновлён 4 часа назад
Бесплатное приложение для заметок с самостоятельным размещением: форматированный текст и Markdown, списки задач, дневник и совместный доступ — альтернатива Notion и Obsidian.
1 тыс.+34 за неделю49JavaScriptMITОбновлён 5 часов назад
Самостоятельно размещаемая вики без базы данных на Go, которая хранит все страницы на диске в виде обычных Markdown-файлов.
62557GoGPL-3.0Активно поддерживаетсяОбновлён 3 дня назад
Публикует папки с Markdown-файлами, заметки и документацию в виде сайтов за секунды: поддерживает перетаскивание файлов, Obsidian, GitHub и CLI для AI-агентов.
1,1 тыс.+2 за неделю120TypeScriptAGPL-3.0Активно поддерживаетсяОбновлён 4 часа назад