commit | 46f1a0cf30c3f93dda3ac9c3138edb9ab963112a | [log] [tgz] |
---|---|---|
author | William Guo <guoyp@apache.org> | Thu Aug 08 16:07:03 2019 +0800 |
committer | William Guo <guoyp@apache.org> | Thu Aug 08 16:07:03 2019 +0800 |
tree | 33475efc9da6aa1953e9285e2bfed6eff4723ea8 | |
parent | b507f545d76b7d3b9669d4dc65de7ca8786c4c03 [diff] |
init faq
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 Apache Griffin's apache repository.
To publish changes, run
bash ./deploy.sh