Генератор документов для Stencil JS - PullRequest
0 голосов
/ 05 июля 2018

Я использую Stencil JS для создания пользовательских веб-компонентов. В какой-то момент я столкнулся с этим требованием для создания документации для созданных пользовательских веб-компонентов. Есть несколько сгенерированных документов, которые я пробовал, такие как typedoc и docsify. Typedoc, кажется, хороший вариант, но он генерирует статический сайт. В моем требовании я предпочитаю позволять пользователю динамически изменять значения кода и просматривать его перед использованием. Для этого я нашел CodeMirror. Есть ли способ интегрировать CodeMirror с TypeDoc, чтобы позволить пользователю редактировать живой код и видеть изменения в веб-компоненте.

Если есть какие-либо другие плагины или генератор, которые выполняют эту работу, пожалуйста, предложите.

Спасибо

1 Ответ

0 голосов
/ 20 июля 2018

Я работаю над тем, что может помочь. На данный момент это немного экспериментально, и больше похоже на Storybook, чем на инструмент для документов, такой как TypeDoc, хотя я также буду больше работать в этом направлении. Все компоненты являются веб-компонентами, встроенными в StencilJS, поэтому документация может стать частью любого проекта, использующего компоненты, которые он документирует, а не отдельным процессом.

https://github.com/steveruizok/st-lookbook

Демо

Скриншот

...