Documentation

Compass is a Jekyll theme designed with something very specific in mind: to be a simple and elegant personal landing page that can be easily deployed to GitHub Pages.

How to use Compass

1. Start by installing Bundler gem install bundler
2. Fork the Compass repository
3. Then run bundle install to get Jekyll and all the dependencies.
4. Clone the repository you just forked: git clone https://github.com/YOUR-USER/compass
5. Edit _config.yml as needed.
6. Run the Jekyll server with bundle exec jekyll serve
7. Go to http://localhost:4000

Deploy your site to GitHub Pages

If you want to use Compass as your personal landing page you can deploy your site to GitHub Pages as a User Page. To do so, when you are done modifying your clone, you should rename your repository to username.github.io where username is your username. When GitHub builds the page it will be made available at https://username.github.io.

If you are planning on using a custom domain to direct to your site, modify the CNAME file as described here.

Check the GitHub Pages Basics for more information.