docsify
Магический генератор документации
Что это такое
docsify генерирует ваш сайт документации на лету. В отличие от GitBook, он не генерирует статические HTML-файлы. Вместо этого он по-умному загружает и парсит ваши файлы в формате Markdown и отображает их в виде веб-сайта. Всё, что вам нужно сделать, это создать index.html для запуска и развернуть его на GitHub Pages.
Смотрите дополнительную информацию в разделе Быстрый старт.
Особенности
- Нет статически созданных файлов HTML
- Простой и легковесный (~19kB gzipped)
- Умный полнотекстовый поиск через плагин
- Различные темы
- Удобный API плагинов
- Поддержка Emoji
- Совместимость с IE10+
- Поддержка SSR (пример)
Примеры
Ознакомьтесь с проектами, использующие docsify.
Donate
Пожалуйста, рассмотрите возможность сделать пожертвование, если вы считаете, что docsify полезен. Я рад, если вы можете мне помочь купить чашку кофе.