commit | 85cd24c8b946490d913d9650f182c6594723cdc4 | [log] [tgz] |
---|---|---|
author | William Guo <guoyp@apache.org> | Wed Sep 12 19:48:38 2018 +0800 |
committer | William Guo <guoyp@apache.org> | Wed Sep 12 19:48:38 2018 +0800 |
tree | 4cdd4090ef1768fc40b3c62df79360738bbaf0bc | |
parent | b424dc9bd926051af0974488d7d9a6ca17eca9e2 [diff] |
add contribute
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