https://github.com/excentris/compass

The Jekyll theme for your personal landing page.
https://github.com/excentris/compass

jekyll jekyll-themes

Last synced: 5 days ago
JSON representation

The Jekyll theme for your personal landing page.

• Host: GitHub
• URL: https://github.com/excentris/compass
• Owner: excentris
• License: mit
• Created: 2015-01-03T21:56:41.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-25T12:04:42.000Z (7 months ago)
• Last Synced: 2025-01-18T14:16:21.128Z (13 days ago)
• Topics: jekyll, jekyll-themes
• Language: HTML
• Homepage: https://excentris.github.io/compass/
• Size: 63.5 KB
• Stars: 194
• Watchers: 6
• Forks: 329
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://pages.github.com/).

## How to use Compass

1. Start by [installing Bundler](http://bundler.io) `gem install bundler`

2. [Fork the Compass repository](https://github.com/excentris/compass/fork)

3. Clone the repository you just forked: `git clone https://github.com/YOUR-USER/compass`

4. Then run `bundle install` to get [Jekyll](http://jekyllrb.com) and all the dependencies.

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](https://help.github.com/articles/user-organization-and-project-pages/#user--organization-pages). 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](https://help.github.com/articles/adding-a-cname-file-to-your-repository/).

Check the [GitHub Pages Basics](https://help.github.com/categories/github-pages-basics/) for more information.