https://github.com/apache/griffin-site

Mirror of Apache Griffin Site
https://github.com/apache/griffin-site

griffin

Last synced: 6 months ago
JSON representation

Mirror of Apache Griffin Site

• Host: GitHub
• URL: https://github.com/apache/griffin-site
• Owner: apache
• License: apache-2.0
• Created: 2017-03-10T08:00:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-15T06:01:22.000Z (almost 5 years ago)
• Last Synced: 2025-04-03T04:16:58.692Z (6 months ago)
• Topics: griffin
• Language: CSS
• Homepage:
• Size: 10.7 MB
• Stars: 1
• Watchers: 7
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Apache Griffin Documentation Site

Welcome to the Apache Griffin documentation!

## Prerequisites

Install [jekyll](https://jekyllrb.com/) 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](http://localhost:4000)

By default, jekyll will generate the site in a `_site` directory.

## Editing documentations

1. Create a markdown file and add following content in header

        ---

        layout: doc

        title:  "Griffin Overview" 

        permalink: /docs/some-new-doc.html

        ---

        

        More content here ..

    

## Publishing the Apache Website

In order to publish the website, you must have committer access to Apache Griffin's apache repository.

To publish changes, run 

```

bash ./deploy.sh

```