Как легко добавлять (и систематизировать) документацию на свой веб-сайт Divi

Вам нужно добавить документацию на один из ваших сайтов Divi? Документация позволяет вам предоставлять всевозможную полезную информацию вашим читателям и клиентам. Но поскольку документация - это отдельный тип контента, вы, вероятно, не захотите смешивать контент документации с обычными сообщениями или страницами WordPress.

Итак, чтобы показать вам, как добавить документацию в WordPress (и, в частности, в установку WordPress с темой Divi WordPress), я собираюсь дать вам краткое руководство по использованию нового бесплатного плагина под названием DocuPress.

Что такое DocuPress и для чего он нужен?

DocuPress - это бесплатный инструмент для добавления документации на любой сайт WordPress. Он был разработан Робертом ДеВоре и возник из-за потребности Роберта в легком инструменте документации для некоторых других его проектов разработки WordPress.

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

Вот что на самом деле делает DocuPress при его установке:

• Создает новый Documentation пользовательских почтовый типа
• Добавляет новую настраиваемую таксономию Коллекции, чтобы разделить вашу документацию на разные категории.
• Предоставляет вам виджет, позволяющий легко отображать элементы документации на боковой панели или в контенте, который вы создаете с помощью Divi Builder (или других инструментов, которые позволяют отображать виджеты внутри ваших сообщений).

В будущем Роберт планирует добавить несколько базовых шорткодов, чтобы дать вам еще больше гибкости.

Если вы хотите увидеть DocuPress в действии, вы можете ознакомиться с реальным примером в документации к плагину Роберта WP Dispensary.

Подчеркнем, что это новый плагин . Хотя он не делает ничего особенно сложного, вы все равно должны всегда помнить об этом, прежде чем сразу же пойти ва-банк.

Как использовать DocuPress для создания документации

Теперь, когда вы знаете, что он делает, вот как вы можете использовать DocuPress для создания документации для вашего собственного сайта WordPress.

Шаг 1. Установите и активируйте DocuPress

DocuPress доступен бесплатно в репозитории плагинов WordPress.org, поэтому вы можете установить его прямо из панели управления WordPress.

После установки вам не нужно ничего настраивать. Помните - это легкое решение!

Шаг 2. Добавьте свои коллекции документации

После активации DocuPress вы должны увидеть новый пользовательский тип публикации « Документация ». Но прежде чем вы начнете добавлять статьи в документацию, вам следует добавить несколько коллекций для категоризации ваших статей.

Для этого перейдите в Документация → Коллекции . Заполните данные и нажмите « Добавить новую коллекцию» . Это работает почти так же, как категория для обычного сообщения WordPress:

Добавьте столько коллекций, сколько вам нужно, чтобы адекватно разделить статьи документации.

Шаг 3. Добавьте статьи в документацию

Когда у вас есть коллекции, перейдите в Documentation → Add New, чтобы добавить актуальные статьи документации. Это в значительной степени обычный редактор WordPress, за исключением одного ключевого дополнения.

Дайте своей статье заголовок и введите содержание сообщения. Затем выберите свою коллекцию, как если бы вы выбрали категорию для обычного сообщения WordPress.

Единственное новое , что вам нужно сделать , это выбрать атрибуты Статьи → Порядок в правом нижнем углу. Это определяет порядок, в котором ваши статьи отображаются в виджете. Например:

• 0 отображается первым
• 1 следующий в списке
• И так далее.

Затем обязательно опубликуйте свою статью.

Повторите процесс для необходимого количества статей документации.

Шаг 4. Отображение коллекций документации

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

• Ваша боковая панель
• Контент, который вы создаете с помощью Divi Builder (или другого инструмента, который позволяет вам использовать виджеты в вашем контенте)

Боковая панель проста - просто перейдите в « Внешний вид» → «Виджеты» и перетащите курсор на виджет «Статьи DocuPress» :

Ты можешь выбрать:

• Заголовок, который отображается над списком статей документации.
• Сколько статей документации показывать
• Показывать ли все коллекции или конкретную коллекцию
• Стоит ли рандомизировать порядок статей

Если вы хотите отображать списки документации в своем контенте, а не на боковой панели, вы можете вместо этого использовать модуль боковой панели Divi.

Для этого начните с добавления нового виджета внизу области виджетов:

Как только вы это сделаете, у вас появится новая область боковой панели документации, в которую вы можете добавить виджет DocuPress:

Если вы хотите отображать разные разделы, вы можете добавить несколько виджетов DocuPress на эту боковую панель.

Затем перейдите в Divi Builder для страницы, на которую вы хотите добавить свою документацию. Добавить новый модуль боковой панели и выберите область документации , которую вы только что создали:

Затем, если вы используете Visual Builder, вы должны увидеть категории документации:

Как и все модули Divi, вы также можете поиграть со стилями на вкладке « Дизайн », если хотите, например, изменить цвет и размер шрифта для заголовков категорий документации:

И, конечно же, вы можете добавить другие модули Divi по мере необходимости, чтобы оживить страницу с документацией. Но это все, что вам нужно сделать, чтобы добавить основные функции документации.

Если вам нужно добавить свою документацию на страницу без Divi Builder, вы также можете использовать плагин, такой как Widget Shortcode, чтобы иметь возможность загружать виджет DocuPress с помощью шорткода.

Заключение

В общем, DocuPress - довольно простое решение для создания и управления документацией в WordPress. Не ждите множества наворотов, но если вам просто нужно что-то простое и легкое, это хороший вариант.

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

Как я уже упоминал, Роберт планирует добавить несколько встроенных шорткодов, поэтому вскоре плагин станет еще проще в использовании.

А теперь к вам - что вы думаете об использовании чего-то легкого, например DocuPress, для вашей документации или документации вашего клиента? Предпочитаете ли вы этот подход для некоторых из наиболее мощных плагинов документации?

Миниатюра статьи: turali / shutterstock.com