Skip to content
This repository has been archived by the owner on Aug 16, 2019. It is now read-only.

Latest commit

 

History

History
63 lines (45 loc) · 1.74 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.74 KB

Trailblazer Documentation

Install

Make sure you have bundle and node installed in your machine and:

mkdir trailblazer-docs
cd trailblazer-docs
git clone [email protected]:trailblazer/trailblazer.github.io.git
cd trailblazer.github.io/
git checkout f6
bundle
npm install
./setup.sh
rm -rf _site
mkdir _site && cd _site
git init && git remote add origin https:/trailblazer/trailblazer.github.io.git
git pull origin master
cd ..

A folder will be created and several Trailblazer repos will be pulled. Their code is used to populate the documentation directly. Magic!

Serve

After installation, run:

bundle exec jekyll serve -I

Go to http://127.0.0.1:4000 and you should see the project running.

In the off chance you stumble upon an empty site, repeat these steps on the project root:

git checkout f6
rm -rf _site
mkdir _site && cd _site
git init && git remote add origin https:/trailblazer/trailblazer.github.io.git
git pull origin master
cd ..

And try to run the Jekyll server again

Contribute

In the previous steps outlining installation, replace [email protected]:trailblazer/trailblazer.github.io.git with the git address of your fork, so you can push your changes to your own fork so you can pull request.

Always work on the f6 branch.

rm -rf _site
mkdir _site && cd _site
git init && git remote add origin https:/trailblazer/trailblazer.github.io.git
git pull origin master

This will make the _site directory reference the master branch. Everything you commit in this directory and push will be pushed to master and published instantaneously.