| 1 | # Seagull Documentation
|
| 2 |
|
| 3 | This is an integrated github-pages documentation built on jekyll's
|
| 4 | [cayman theme](https://github.com/jasonlong/cayman-theme). Github will
|
| 5 | automatically (re-)build the [website](https://seagull-js.github.io/seagull-cli/)
|
| 6 | whenever content within this `docs` folder changes.
|
| 7 |
|
| 8 | ## Website
|
| 9 |
|
| 10 | https://seagull-js.github.io/seagull-cli/
|
| 11 |
|
| 12 | ## Local Docs development
|
| 13 |
|
| 14 | You will need ruby installed, together with the gems `jekyll` and `bundler`.
|
| 15 | Then `cd` into this directory and run `bundle install` once. Afterwards you
|
| 16 | can execute `bundle exec jekyll serve --watch` for a live-reloading web server
|
| 17 | that updates whenever you change some text files here.
|