commit | 32c1e7a277a05be49c06b0bee96a54bca4f8f3cd | [log] [tgz] |
---|---|---|
author | William Guo <guoyp@apache.org> | Thu Sep 13 21:09:29 2018 +0800 |
committer | William Guo <guoyp@apache.org> | Thu Sep 13 21:09:29 2018 +0800 |
tree | 1b82e013ca085a2399b1286d1fd94a520837e830 | |
parent | c23abb4304df51d095630fb11258c2cdea70caa2 [diff] |
refine quickstart
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