mirror of
https://github.com/spice2x/spice2x.github.io.git
synced 2026-08-01 22:30:42 -07:00
sp2xdev
22 lines
1.5 KiB
Markdown
22 lines
1.5 KiB
Markdown
# 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.
|