weDocs — Knowledgebase and Documentation Plugin for WordPress

Описание

Создавайте красивую документацию для своих продуктов. Красиво оформляйте документацию по продукту на своем сайте!

С помощью данного плагина вы можете размещать документы на вашем сайте WordPress, создавать/добавлять новые документы, упорядочивать их по, распределять по тегам и даже получать документы с внешних сайтов.

Этот плагин чрезвычайно удобен для предоставления длинной и подробной документации по вашему продукту/плагину WordPress.

WeDocs делает просмотр и создание документации удобным и приятным в знакомой среде WP.

Сотрудничество

В плагине могут обнаруживаться ошибки и отсутствие каких-то функций. Если вы хотите внести свой вклад в этот проект — добро пожаловать. Создавайте форк репозитория на Github.

Автору

Плагин предоставлен разработчиком по имени Tareq Hasan из weDevs.

Скриншоты

  • Интерфейс администратора
  • Документация по конструктору пользовательского интерфейса администратора
  • Действия пользовательского интерфейса
  • Переключение на классический интерфейс
  • Классический интерфейс документов
  • Все документы во фронтэнде через шорткод
  • Просмотр отдельного документа с навигацией
  • Виджет поиска
  • Виджет поиска во фронтенде

Установка

Извлеките zip-файл и просто поместите его содержимое в каталог wp-content/plugins/ вашей установки WordPress, а затем активируйте плагин в списке установленных плагинов.

Часто задаваемые вопросы

Что такое Appsero

weDocs использует SDK Appsero для сбора некоторых данных телеметрии после подтверждения пользователя. Это помогает нам быстрее устранять проблемы и улучшать наши продукты.

Appsero SDK по умолчанию не собирает никаких данных. SDK начинает сбор базовых данных телеметрии только тогда, когда пользователь разрешает это через уведомление администратора. Мы собираем данные, чтобы обеспечить удобство работы всех наших пользователей.

Интеграция Appsero SDK не начинает сбор данных немедленно, в любом случае без подтверждения от пользователей.

Узнайте детали того как Appsero собирает и использует эти данные.

Отзывы

14.10.2020
It is a very useful plugin, that does what it should do. But one big pitfall in this plugin is that, when you want to add a new page, it asks for the name, and then instantly publishes the page (!!!), which leads to have a public blank page on the site. then you have to go to edit page, and make it draft again, until your content is final and, ready to be published.
19.07.2020
The archive page structure is different from WordPress standard. No Search result page feature. Customized, but less functionality WordPress Admin module. I am developer user, and I was able to customize these to work with WordPress Coding Standard. However, most users are hard to use this, when taking care of seo and site design.
09.07.2020
I want to thank Tareq for this great plugin. I compared multiple knowledge plugins with the following requirements: - easy to use - separate document type - compatible with wordpress search - compatible with wordpress language plugin weglot In the end I decided to choose wedocs and I am super happy with it. I managed to create a beautiful looking knowledge base in multiple languages. Thanks again and keep on going. Best regards Christoph
Посмотреть все 55 отзывов

Участники и разработчики

«weDocs — Knowledgebase and Documentation Plugin for WordPress» — проект с открытым исходным кодом. В развитие плагина внесли свой вклад следующие участники:

Участники

«weDocs — Knowledgebase and Documentation Plugin for WordPress» переведён на 11 языков. Благодарим переводчиков за их работу.

Перевести «weDocs — Knowledgebase and Documentation Plugin for WordPress» на ваш язык.

Заинтересованы в разработке?

Посмотрите код, проверьте SVN репозиторий, или подпишитесь на журнал разработки по RSS.

Журнал изменений

v1.7 (3rd September, 2021)

  • Новое: Добавлена ​​поддержка темы Astra. Раньше отдельные страницы документов были узкими по ширине, теперь они будут на всю ширину страницы.

v1.6.3 (28th July, 2021)

  • Улучшение: совместимость с WordPress 5.8.
  • Улучшение: некоторые модальные тексты не были переведены должным образом, теперь это исправлено.

v1.6.2 (2nd Sep, 2020)

  • Исправлено: Проблема обратного вызова разрешения REST API в WP 5.5.

v1.6.1 (5th June, 2020)

  • Новое: Загрузка файлов CSS и JS только для документов. Исправляет #104
  • Исправлено: Добавлены отсутствующие текстовые домены. #105
  • Исправлено: API поиска cрывался из-за проблемы с пространством имен с WP_Query. #108

v1.6 (8 April, 2020)

  • Новое: добавлена ​​расширенная функциональность для вложенных документов во фронтенде. Из одного документа можно просмотреть всю документацию, щёлкая значок переключения на боковой панели.
  • Рефакторинг: плагин был переработан для использования пространства имен PHP. Теперь код плагина более организован.
  • Прочее: добавлен Appsero SDK для сбора данных телеметрии.

v1.5 (11 July, 2019)

  • Новое: добавлена ​​поддержка REST API.
  • Новое: добавлена ​​поддержка комментариев в отдельном документе.

v1.4.1 (26 August, 2018)

  • Исправление: обновлена ​​версия Vue.js до 2.5.16, а также добавлена ​​минифицированная версия.

v1.4 (25 August, 2018)

  • Новое: добавлен новый атрибут шорткода (элементы) для ограничения количества отображаемых элементов. #59
  • Новое: Добавлен новый фильтр wedocs_email_feedback_to для исходящей почты на адрес. #63
  • Новое: добавлена ​​поддержка обёртки темы. Теперь разработчики смогут размещать динамические начальные/конечные div’ы и теги в шаблоне single-docs.php.
  • Новое: отображение документов 3-го уровня в конструкторе пользовательского интерфейса администратора.
  • Новое: добавлены автоматические теги привязки в документах для тегов h2 и h3. Создавать закладки теперь очень просто! Спасибо anchorjs.
  • Исправлено: ошибка с кавычками в заголовке документа. #66
  • Улучшено: Сброс правил перезаписи после активации плагина. Устраняет проблемы с длительными постоянными ссылками в 404.
  • Улучшено: отключение прокрутки страницы при открытом модальном окне обратной связи.

v1.3.3 (8 November, 2017)

  • Улучшено: корректная проверка ролей пользователей и разрешений при создании и удалении документа. Раньше каждый, у кого был доступ к пользовательскому интерфейсу, мог создавать и удалять любые документы. Ранее проверка возможностей пользователя не проводилась, эта версия устраняет проблему.

v1.3.2 (15 October, 2017)

  • Исправлено: удаление зависимости WPUF от допродажи weForms.
  • Новое: отображение документации и таксономии в REST API. #44
  • Новое: список дочерних статей, если они есть в отдельном документе. #34
  • Новое: добавлена ​​поддержка атрибута страницы для типа записи документа. Теперь можно изменить родительский документ на странице редактирования документа.
  • Улучшено: обновление Vue до 2.5.1 с 1.0.16.
  • Улучшено: каждый пользователь может увидеть переключатель на классический пользовательский интерфейс.

v1.3.1 (24 August, 2017)

  • [улучшение] Добавлен справочник weForms.

v1.3 (21 August, 2017)

  • [исправлено] Добавлены отсутствующие текстовые домены и поддержка Qtranslate в отзывах на документы по Email’у.
  • [исправлено] Заключительное эхо цепочки навигации перемещено из родительского предложения if и удален результирующий избыточный делимитер. #23
  • [исправить] Перевод кнопки отправки. #38
  • [исправлено] Тайм-аут печати увеличен до 2 секунд.
  • [исправлено] Неправильная привязка тега post_type в edit-tags.php в админке. #40
  • [улучшение] Добавлен фильтр по типу сообщений в wedocs
  • [новое] Добавлен испанский язык (# 37)
  • [новое] Добавлены настройки страницы документов, удален архив сообщений. Добавлены настройки «Главная страница документов», чтобы использовать ее в качестве домашней страницы документации. Создается страница документации при активации, если отсутствует.
  • [новое] Добавлен фильтр wedocs_breadcrumbs_html для настройки HTML-кода цепочки навигации.
  • [новое] Добавлена ​​функция wedocs_get_publish_cap() для динамической привязки ролей в меню администратора, поддержки статуса ожидания публикации. #42

v1.2.1 (1 November, 2016)

  • [исправлено] Пропущено диалоговое окно автоматической печати

v1.2 (1 November, 2016)

  • [новое] Добавлена ​​опция печати
  • [новое] Модальное контактное окно
  • [новое] Адаптивность
  • [новое] Реализация микроданных (schema.org)
  • [новое] Дата последнего обновления
  • [новое] Страница настроек

v1.1 (24 October, 2016)

  • ПРОПУЩЕННАЯ ВЕРСИЯ из-за ошибки выпуска

v1.0 (24 October, 2016)

  • [новое] Добавлен персидский язык
  • [новое] Добавлен французский перевода, адаптивность и полная поддержка QtranslateX
  • [исправлено] Прикрепление объекта $event к методу addArticle
  • [исправлено] Опечатка в имени ключа (вызывает уведомление PHP в строке 111 $args['after']).

v0.1 (2 march, 2016)

  • Первый выпуск