commit | 053b3172e210f0304bdfe20aa6b3e6709aa6f697 | [log] [tgz] |
---|---|---|
author | William Guo <guoyp@apache.org> | Fri Sep 14 09:32:18 2018 +0800 |
committer | William Guo <guoyp@apache.org> | Fri Sep 14 09:32:18 2018 +0800 |
tree | 3110576a95bd9d133ee55d90d4fd674230409847 | |
parent | 7c926c570c7c2b70055cc028c264ba54eab7a9ff [diff] |
This closes #5 merge
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