first commit

2025-11-22 22:14:33 +03:00
commit b4d17173e5
12 changed files with 422 additions and 0 deletions
@@ -0,0 +1,43 @@
+# Создание структуры сайта-документации на docsify
+
+**docidoci** — это cli программа для создания структуры сайта-документации на docsify.
+
+При базовой конфигурации docsify сайт не выглядит впечатляющим, поэтому в 100% случаев к нему добавляют плагины и изменяют начальную конфигурацию. С помощью docidoci можно создать проект за считанные секунды, в котором не нужно тратить время на подключение:
+
+1. Навигационной и боковой панели, а так же титульной страницы и страницы 404
+
+2. Переключения световой темы
+
+3. Подсветки и копирования кода
+
+4. Поиска по документации
+
+5. Небольшой seo оптимизации сайта
+
+6. Прочего
+
+После создания проекта плагины по умолчанию можно легко отключить или подключить свои.
+
+## Установка
+
+Скачать docidoci можно с помощью следущей команды:
+
+```bash
+npm i -g docidoci
+```
+
+## Использование
+
+Интерфейс программы предоставлет собой три команды:
+
+### docidoci help
+
+Выводит список доступных команд. Так же посмотреть список команд можно введя docidoci без параметров
+
+### docidoci settings
+
+Создаёт в текущей дирректории файл `docidociSettings.json` с помощью которого осуществляется настройка проекта. В файле можно указать название проекта, ссылку на репозиторий, цветовую тему, данные для seo и другое. Создание файла настроек не является обязательным, но оно поможет ускорить процесс создания сайта.
+
+### docidoci init
+
+Самая главная команда, использующаяся для создания структуры проекта. Если в текущей дирректории существует файл `docidociSettings.json`, то проект будет создан на основе вписанных настроек, иначе — будет создана более "скромная" версия проекта.