Skip to content

Provides a plugin that starts `live-server` providing refresh of the output doc target during TJSDoc execution.

License

Notifications You must be signed in to change notification settings

typhonjs-node-tjsdoc-plugins/tjsdoc-plugin-live-server

Repository files navigation

tjsdoc-plugin-live-server

Provides a plugin that starts live-server providing refresh of the output doc target during TJSDoc execution. This plugin may be used separately or be depended on by any of the watcher plugins. For instance tjsdoc-plugin-watcher-doc-regenerate will automatically add tjsdoc-plugin-live-server when it is passed an option "live-server": true. This will open a browser w/ index.html of the generated docs and as ongoing documentation regeneration occurs the browser will refresh new content.

For essential information pertaining to TJSDoc please refer to tjsdoc.

About

Provides a plugin that starts `live-server` providing refresh of the output doc target during TJSDoc execution.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published