Все знают, как трудно обучать новичков на предприятии, когда они спрашивают вещи, которые, возможно, даже вы не знаете. Вот почему многие предприятия решили иметь собственную базу знаний, независимо от причин, например, документация, инструкции для стажеров и т. Д. Однако они не тратят время на разработку, когда есть инструменты с открытым исходным кодом, которые удовлетворяют эту потребность.
В этом топе мы поделимся с вами 5 открытыми вики-приложениями с открытым исходным кодом Node.js, которые вы можете легко разместить на своих собственных серверах и начать работу с документацией своих проектов.
5. OpenKB
openKB — это приложение базы знаний Markdown (FAQ), созданное с использованием Nodejs и ExpressJS. Приложение по умолчанию использует встроенную базу данных (nedb), но также может использовать сервер MongoDB, изменив конфигурацию (см. Ниже). Приложение разработано так, чтобы его было легко использовать и устанавливать, и оно основано на поиске, а не на вложенных категориях. Просто найдите то, что вы хотите, и выберите из результатов. Особенности этого проекта:
- Поиск: openKB — это база знаний (FAQ) на основе поиска, поддерживаемая Lunr.js индексация для создания наилучших результатов поиска.
- Backend: openKB использует чистый Javascript nedb встроенная база данных по умолчанию или сервер MongoDB.
- Дизайн / ТемыopenKB предназначен для простого плоского дизайна. Темы могут быть добавлены путем создания папки темы в
public/themes/, Смотрите пример темы для получения дополнительной информации. - отзывчивый: openKB построен с использованием Bootstrap, что позволяет ему быть отзывчивым и работать на всех устройствах.
adminможет быть немного сложнее редактировать Markdown на небольших экранах. - Русалочка: openKB позволяет Русалочка графики в статьях.
- редактор: openKB использует Markdown-it, основанный на CommonMark spec. Это учитывает самый лучший опыт уценки.
- Управление имиджем: openKB позволяет перетаскивать изображения в статьи. Изображение автоматически загружается на сервер в фоновом режиме. Пользователи Google Chrome также могут вставлять изображения прямо из буфера обмена.
4. джингоист
Jingo — это вики-движок на основе git, написанный для node.js, с достойным дизайном, возможностями поиска и хорошей типографикой. Цель этого вики-движка — предоставить простой способ создания централизованной области документации для людей, привыкших работать с git и markdown. Он должен хорошо вписываться в команду разработчиков без необходимости изучать сложное и обычно избыточное приложение. Jingo очень вдохновлен (и совместим с форматом) собственной вики-системой github Gollum, но он пытается быть более автономной и полной системой, чем Gollum. Думайте о дзинго как о «github wiki, без github, но с большим количеством функций». «Джинго» означает «Джинго не Голлум» по нескольким причинам. Особенности этого проекта:
- Нет базы данных: Jingo использует репозиторий git в качестве архива документов
- Уценка за все, Github со вкусом
- Джинго использует CodeMirror или же Markitup как редактор разметки, с хорошим (ajax) предварительным просмотром (см.
featuresвведите файл конфигурации) - Он обеспечивает «почти без отвлечения», почти полноэкранный режим редактирования
- Совместим с вики, созданной с Голлум вики
- История изменений для всех страниц (с восстановлением)
- Показать различия между версиями документа
- Разбитый на страницы список всех страниц, с быстрым способом найти изменения между ревизиями
- Поиск по содержанию и названиям страниц
- Макет страницы принимает пользовательские боковую панель и нижний колонтитул
- Граватарская поддержка
- Может включать в документ IFRAME (например, вставлять документ Google Диска)
- Создать оглавление для страниц
- Может использовать пользовательские скрипты CSS и JavaScript
- Белый список для авторизации на странице чтения и записи
- Обнаруживает неписанные страницы (которые будут выделены красным цветом)
- Автоматически нажимать на пульт (опционально)
- Мобильный дружественный (на основе Bootstrap 3.x)
- Вполне настраиваемый, но также работает из коробки
- Хорошо работает за прокси-сервером (т. Е. Вики можно «смонтировать» как каталог на другом сайте)
- Страницы могут быть встроены в другой сайт
- Аутентификация через Google, Github, LDAP и локальное имя / пароль
3. Raneto
Raneto — это база знаний, основанная на уценке для Nodejs, которая использует статические файлы уценки для расширения базы знаний. Raneto можно назвать своего рода «генератором статического сайта», так как он не требует базы данных. Весь ваш контент хранится в content папка в уценке (.md) файлы и вся структура и контент базы знаний создаются Raneto. Это хорошо, потому что это:
- Просто: Вы можете создавать и управлять всей базой знаний, используя ваш любимый текстовый редактор.
- Плоский: Raneto — это CMS с «плоскими файлами», что означает отсутствие проблем с базами данных, запросов MySQL, ничего
- Быстро: Raneto серьезно облегчает работу и не использует базу данных, что делает ее очень быстрой
Raneto также имеет:
- Усы для простого шаблона
- Отзывчивый шаблон по умолчанию (питание от начальная загрузка)
- Highlight.js подсветка синтаксиса кода
- Полнотекстовый поиск Lunr
- GitHub Ароматизированная уценка
2. Matterwiki
Matterwiki — это очень простая и красивая вики для команд, поэтому они могут использовать ее для хранения документации, заметок, руководств по культуре, учебных пособий, содержания сотрудников и всего, что они хотят. В отличие от традиционных программ для вики, Matterwiki использует простой редактор WYSIWYG. Это означает, что нет сложного форматирования или структуры для подражания. Среда редактирования, в которой вам удобно. WYSIWYG = То, что вы видите, это то, что вы получаете. Matterwiki использует API-интерфейс Node.js с внешним интерфейсом React.js и Sqlite3 для базы данных.
1. Wiki.js
Wiki.js — это современное и мощное вики-приложение с открытым исходным кодом, основанное на Node.js, Git и Markdown. Наиболее известными особенностями этой вики является использование простого формата Markdown, он очень легкий, имеет встроенный контроль доступа (служба регистрации), вход в социальную сеть, чтобы обеспечить бесперебойный вход в систему для ваших пользователей и полезное и интуитивно понятное управление активами. особенность.
Одним из самых удивительных факторов, которые ставят Wiki.js на первое место в этой статье, является их удивительная особенность в том, чтобы сделать весь ваш контент красивым графически. Содержание обрабатывается в красивый формат чтения, представленный в элегантном пользовательском интерфейсе. Меню боковой панели генерируется для каждой страницы на основе ваших заголовков, а разделы отображаются в разных цветах для улучшения читабельности, это очень хорошо, верно? И, как уже упоминалось в этой статье, вы можете свободно просматривать полный исходный код и добавлять новые функции! Разместите его на своих локальных серверах, в облаке или даже дома. Это абсолютно бесплатно.
Если вы знаете другое замечательное приложение с открытым исходным кодом для создания вики / базы знаний для размещения его на своих собственных серверах, не стесняйтесь и поделитесь им с сообществом в поле для комментариев.
