Шаблон документации для репозитория

• gerzhan.github.io/gerzhan-tpl-docs-repo
• github.com/gerzhan/gerzhan-tpl-docs-repo

Инструкция

• скопируйте код репозитория и распакуйте zip-архив

# копирование текущей версии структуры документации
$curl -LS https://github.com/gerzhan/gerzhan-tpl-docs-repo/archive/refs/heads/main.zip -o docs.zip
# распаковка только директории с документацией
$unzip docs.zip 'gerzhan-tpl-docs-repo-main/docs' -d './'

• перенесите директорию docs в корневую директорию своего репозитория
• замените/удалите в docs/index.html блок Yandex.Metrika counter
• измените описание документации в конфигурации для docsify(window.$docsify) в файле docs/index.html
• установите docsify на локальной машине глобавльно или добавьте в корневой package.json

# установить глобально
$npm i docsify-cli -g
# установить локально
$npm i -D docsify-cli

• добавить в package.json команду запуска сервера отображения документации

"script": {
+ "docs": "docsify serve ./docs -p 4233",

• запустить локальный сервер для формирования и просмотра документации

$npx run docs

Первоисточники

• Defining an efficient documentation structure