Создание интерактивной документации из исходного кода JavascriptJavascript

Форум по Javascript
Anonymous
Создание интерактивной документации из исходного кода Javascript

Сообщение Anonymous »

Я работаю над проектом Electron и могу генерировать JSON для своего кода с помощью JSDoc:

Код: Выделить всё

jsdoc -X > data.json
Я хочу использовать этот вывод JSON для создания живого сайта документации с возможностью поиска, похожего на DevDocs. Под этим я подразумеваю следующее:
  • Ввод чего-то вроде get_ должен мгновенно отфильтровать и вывести список всех соответствующих функций, классов или переменных.
  • Пользователи должны иметь возможность щелкнуть символ и перейти к его подробной документации.
  • На сайте должно отображаться, какому модулю или файлу принадлежит каждый символ.
  • Поиск и навигация должны осуществляться полностью на стороне клиента, без перезагрузки страницы.
Мне нужны рекомендации по следующим вопросам:
Как использовать JSON, сгенерированный из исходного кода, для создания сайта документации с доступным для поиска и навигации содержимым.
Я рад рассмотреть альтернативы JSDoc, а также открыт для любых существующих инструментов и платформ. это может помочь мне достичь этой цели.

Подробнее здесь: https://stackoverflow.com/questions/798 ... ource-code

Вернуться в «Javascript»