INSTALL THE DOCS WITH JEKYLL

less than 1 minute read


The documentation is produced with :


For a local deployment of the documentation project (Jekyll + MMistakes template)


  • Install ruby, Jekyll
brew install ruby
gem install jekyll
  • From your repo’s root go to the /docs folder
cd /docs
  • Install setup (given the Gemfile, Gemfile.lock and _config.yml files)
gem install bundler
bundle
bundle install
bundle update
  • Launch Jekyll server
jekyll serve

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

… then check in your browser :

127.0.0.1:4010