| commit | e931bbcd8ed9aa48bc5abf426410c266e44d7a8e | [log] [tgz] |
|---|---|---|
| author | William Guo <guoyp@apache.org> | Wed Sep 12 17:19:48 2018 +0800 |
| committer | William Guo <guoyp@apache.org> | Wed Sep 12 17:19:48 2018 +0800 |
| tree | 22895b57bdcea95ae78cd322983b351d88b4a7b6 | |
| parent | ca1c37a79073c9ca54e4cfa0006de142502eb353 [diff] |
readme
Welcome to the Apache Griffin documentation!
Install jekyll gem
$ gem install jekyll
Generate the site, and start a server locally:
$ jekyll serve -w
The -w option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.
Point your browser to http://localhost:4000
By default, jekyll will generate the site in a _site directory.
Create a markdown file and add following content in header
--- layout: doc title: "Griffin Overview" permalink: /docs/some-new-doc.html --- More content here ..
In order to publish the website, you must have committer access to Griffin's apache repository.
To publish changes, run
bash ./deploy.sh