search

rakutentech / docpub

DocPub is a command line utility for converting a folder structure of markdown files to HTML and uploading the result to Zendesk.
MIT License
12 stars 16 forks source link

Publish docpub documentation GH pages using gitbook #34

Open SwinX opened 7 years ago

SwinX commented 7 years ago

This issue is about publishing docpub's own documentation to GH pages, not about publishing 3rd-party documentation to the gitbook service.

Example of gitbook output: http://redux.js.org

Gitbook CLI: https://www.npmjs.com/package/gitbook-cli GH pages: https://pages.github.com

Proposed flow: On each build CI triggers gitbook build so we may make sure that documentation is not corrupted On each release we person, responsible for release will also need to publish gitbook manually. (probably this could be automated too?)

SwinX commented 7 years ago

About automating - we may add book publishing to postpublish husky hook. So when we would push new release to NPM, book would be updated automatically