obs-websocket/docs
2021-04-26 18:39:00 -07:00
..
generated docs(ci): Update generated docs - cfb66fd [skip ci] 2021-04-27 00:59:44 +00:00
partials docs: Add more from protocol spec gist 2021-04-26 18:38:47 -07:00
.editorconfig Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
.gitignore Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
.npmrc Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
comments.js Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
config.json Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
docs.js Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
package.json docs: Lots of changes 2021-04-26 09:55:50 -07:00
protocol.hbs docs: Lots of changes 2021-04-26 09:55:50 -07:00
README.md Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00

Installation

Install node and update npm if necessary.

cd obs-websocket/docs
npm install

Build

# Just extract the comments.
npm run comments

# Just render the markdown.
npm run docs

# Do both comments and markdown.
npm run build