Skip to content

Latest commit

 

History

History
61 lines (29 loc) · 1.29 KB

WEBSITE.md

File metadata and controls

61 lines (29 loc) · 1.29 KB

Github.io Website

The website is stored in <path/to/project>/docs/.

It uses Jekyll (a Ruby app) and the Hideout theme.

How to post

Add a *.md file under <path/to/project>/docs/_posts

How to run the website locally

  1. Install Ruby.

  2. Install the gems: Jekyll and Bundler. Open a console and type:

     > gem install jekyll
     > gem install bundler
    
  3. Build the site and make it available on a local server:

     > cd <path/to/project>/docs/
    
  4. Run

     > bundle exec jekyll serve
    

The site is available at localhost:4000/ArrowDL

How to upgrade Jekyll

To upgrade Jekyll, open a console and type:

> bundle update jekyll

or alternatively:
> bundle update

How to clean

To clean the directory <path/to/project>/docs/:

> bundle exec jekyll clean

To clean Jekyll:

> bundle clean --force

How to upgrade the dependencies (Hideout...)

  1. Unzip last release in Hideout to /docs/

  2. Revert modification with Git

  3. Eventually upgrade with Bundle