On Rewind API specifications (in OpenAPI/Swagger) used in doc-api.onrewind.tv Every updates converts the open api specs into slate markdown and then publish the static website in gh-pages branch.
- docker
- node.js >= 8
- clone this project
npm install
npm run docker:init
The following commands are available using npm run
:
openapi:compile
: compile split openapi spec files into oneopenapi:watch
: open a swagger ui preview in your browser, hot reload enabled if you modify any specsslate:init
: transpile openapi spec into slate spec and copy slate resources into tmp folder, should be run for any changesslate:preview
: open a slate preview in your browser, based on content in tmp folderslate:compile
: compile all files to build a slate static site into dist folder, based on content in tmp folderdocker:init
: build docker image needed for slatedist
: combine commands to generate openapi spec and static site in one go
This project is licensed under the Apache 2.0 License - see the LICENSE file for details
Thanks to the following projects/organization that helps us writing better documentation :)
- swagger
- widdershins
- docker
- slate
- and other libraries defined in
package.json