Требовался максимально простой и легковесный генератор документации. Писать документацию на "голом" HTML может оказаться довольно долгим, на Markdown же намного проще и быстрее. Из него очень легко сгенерировать HTML-страницы.
Кроме того, требовалось реализовать простую документацию без JS и прочих тяжеловесных элементов. Документация должна работать без поднятия серверов и пр., а так же корректно отображаться в консольных браузерах типа Links, Elinks, Lynx или w3m.
- Поддержка генерации нескольких страниц за раз;
- Генерация ссылок навигации (далее, назад, домой);
- Генерация содержания;
- Поддержка таблиц;
- Поддержка вставок кода;
- Поддержка CSS;
- Отдельная директория со сгенерированными html-страницами;
- Генерация одностраничного HTML-документа;
Вся конфигурация описана в файлe conf.json
. В pages
описаны страницы, в css
- сторонние CSS-стили.