[Docs] Try Gitbook! #387
[Docs] Try Gitbook! #387
Conversation
|
|
||
|
|
||
|
|
||
| ```sh | ||
| npm install bs-platform --save |
There was a problem hiding this comment.
Sorry, a bit of noise here introduced by my editor's setting of trimming dangling whitespace. Whitespace-less diff view: https://github.com/bloomberg/bucklescript/pull/387/files?w=1
|
this looks great except do we have to remove files in dist to make gitbook happy? |
|
No we don't. There's just no need anymore for any of the things in dist/ except images, so I singled the latter out. |
|
can you keep it for this commit, I will remove it once I get familiar with gitbook, thanks |
The docs pages reminded me of the [Gitbook](https://github.com/GitbookIO/gitbook) format, except with the latter, you wouldn't need to maintain anything yourself. Here's an example of such doc: http://redux.js.org `npm run watch` is all you need to set up a watcher that live reflects your changes to localhost:4000. `npm run build` to publish into _book, which I put into .gitignore, as I'm not sure how publishing to gh-pages work.
|
Sure thing. I've restored |
|
Thank you! |
…xternal_garbage not display external garbage
The docs pages reminded me of the Gitbook format, except with the latter, you wouldn't need to maintain anything yourself.
Here's an example of such doc: http://redux.js.org
npm run watchis all you need to set up a watcher that live reflects your changes to localhost:4000.npm run buildto publish into _book, which I put into .gitignore, as I'm not sure how publishing to gh-pages work.Here's a live preview of the book =).