Создание структуры сайта-документации на docsify

docidoci — это cli программа для создания структуры сайта-документации на docsify.

При базовой конфигурации docsify сайт не выглядит впечатляющим, поэтому в 100% случаев к нему добавляют плагины и изменяют начальную конфигурацию. С помощью docidoci можно создать проект за считанные секунды, в котором не нужно тратить время на подключение:

Навигационной и боковой панели, а так же титульной страницы и страницы 404
Переключения световой темы
Подсветки и копирования кода
Поиска по документации
Небольшой seo оптимизации сайта
Прочего

После создания проекта плагины по умолчанию можно легко отключить или подключить свои.

Установка

Скачать docidoci можно с помощью следущей команды:

npm i -g docidoci

Использование

Интерфейс программы предоставлет собой три команды:

docidoci help

Выводит список доступных команд. Так же посмотреть список команд можно введя docidoci без параметров

docidoci settings

Создаёт в текущей дирректории файл docidociSettings.json с помощью которого осуществляется настройка проекта. В файле можно указать название проекта, ссылку на репозиторий, цветовую тему, данные для seo и другое. Создание файла настроек не является обязательным, но оно поможет ускорить процесс создания сайта.

docidoci init

Самая главная команда, использующаяся для создания структуры проекта. Если в текущей дирректории существует файл docidociSettings.json, то проект будет создан на основе вписанных настроек, иначе — будет создана более "скромная" версия проекта.

2.7 KiB Raw Blame History