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.
- Start by installing Bundler
gem install bundler - Fork the Compass repository
- Clone the repository you just forked:
git clone https://github.com/YOUR-USER/compass - Then run
bundle installto get Jekyll and all the dependencies. - Edit
_config.ymlas needed. - Run the Jekyll server with
bundle exec jekyll serve - Go to
http://localhost:4000
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.