Ищите вики-документацию по API для решения на основе jsdoc

Question

У нас есть большой кусок кода JS, документированный с помощью синтаксиса jsdoc, который мы хотели бы включить во внутреннюю вики в автоматическом режиме.

Соответственно, я ищу вики-решение, способное автоматически генерировать страницы с помощью jsdoc из нашей кодовой базы.

Любая идея?

Answer 1

1. Сначала я рекомендую проверить, имеет ли код приложения действительный и полный jsdoc, используя eslint: valid-jsdoc.

2. Из действительного jsdoc можно сгенерировать:

   • Использовать генератор шаблонов по умолчанию из jsdoc
   • Простой инструмент docdown, который генерирует уценку
   • Более сложный Docdash с такими опциями, как шаблоны (например, lodash.com), экспортная конфигурация и т. Д. Он генерирует полный HTML.

Answer 2

Вы можете использовать встроенную функцию JSDoc для генерации из исходного кода и применения к нему собственного шаблона. Затем из вашего WIKI вы просто ссылаетесь на созданные им HTML-страницы. Вы можете автоматизировать это, используя cron для запуска генератора страниц JSDoc каждый раз и используя его шаблонную функциональность, чтобы он выглядел точно так же, как ваша вики, поэтому, когда вы ссылаетесь на нее из вики, она не выглядит иначе. Это то, что мы делаем.