INSTALL THE DOCS WITH JEKYLL

Deploy the present documentation

---

The documentation is produced with :

• Github pages
• Jekyll
• Minimal Mistakes template

---

Local deployment of the documentation project

• Install ruby, Jekyll

  brew install ruby
  gem install jekyll
  

  
  

• Install setup (given the Gemfile, Gemfile.lock and _config.yml files)

  gem install bundler
  bundle
  bundle install
  bundle update
  

  
  

• Launch Jekyll server

  bundle exec jekyll serve
    
  # or if you want to run the docs server on another port
  bundle exec jekyll serve --port=4001
  

  
  

• then check in your browser : 127.0.0.1:4000

---

Deployment on Github pages

Check the following links :

• Jekyll / gh-pages
• MMiistakes / gh-pages

---