| commit | 4d6cfb44402863ef207cf58c39e5732196320175 | [log] [tgz] |
|---|---|---|
| author | William Guo <guoyp@apache.org> | Fri Sep 21 09:20:22 2018 +0800 |
| committer | William Guo <guoyp@apache.org> | Fri Sep 21 09:20:22 2018 +0800 |
| tree | 02a01e106a92185211565d2777a86d0c73da88b3 | |
| parent | 1e29d1a3fda89b51e8fb21e2d0c9de1bf3d60825 [diff] |
add docs link
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