hacks-guide-minimal-mistake.../_docs/01-quick-start-guide.md

49 lines
2.4 KiB
Markdown
Raw Normal View History

2016-03-25 19:12:25 +01:00
---
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
redirect_from:
- /docs/
excerpt:
2016-03-25 19:12:25 +01:00
sidebar:
2016-04-06 03:50:10 +02:00
title: "v3.0"
2016-03-25 19:12:25 +01:00
nav: docs
---
2016-03-29 22:53:39 +02:00
{% include base_path %}
2016-04-04 22:36:26 +02:00
Minimal Mistakes has been developed to be 100% compatible with hosting a site on [GitHub Pages](https://pages.github.com/). To get up and running with a new GitHub repository quickly, follow these steps.
2016-03-29 22:53:39 +02:00
2016-04-04 22:36:26 +02:00
## Fork the Theme
2016-03-29 22:53:39 +02:00
2016-04-12 20:34:36 +02:00
Fork the [Minimal Mistakes theme]({{ site.gh_repo }}/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
2016-04-04 22:36:26 +02:00
2016-04-05 02:44:44 +02:00
<figure>
<img src="{{ base_path }}/images/mm-theme-fork-repo.png" alt="fork Minimal Mistakes">
</figure>
2016-04-04 22:36:26 +02:00
2016-04-05 22:55:13 +02:00
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).
2016-04-04 22:36:26 +02:00
{: .notice--warning}
If you're hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than **USERNAME.github.io** and create a `gh-pages` branch off of `master`. For more details on how to set things up check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/).
2016-04-05 02:44:44 +02:00
<figure>
<img src="{{ base_path }}/images/mm-gh-pages.gif" alt="creating a new branch on GitHub">
</figure>
2016-04-04 22:36:26 +02:00
2016-04-11 22:19:43 +02:00
**ProTip:** Be sure to [delete](https://github.com/blog/1377-create-and-delete-branches) the `gh-pages` branch if you forked Minimal Mistakes. This branch contains the documentation and demo site for the theme and you probably don't want that showing up in your repo.
{: .notice--info}
2016-04-04 22:36:26 +02:00
## Customize Your Site
Open up `_config.yml` found in the root of the repo and edit anything under **Site Settings**. For a full explanation of every setting be sure to read the **Customization** section, but for now let's just change the site's title.
2016-04-05 02:44:44 +02:00
<figure>
<img src="{{ base_path }}/images/mm-github-edit-config.gif" alt="editing _config.yml file">
<figcaption>Edit text files without leaving GitHub.com</figcaption>
</figure>
2016-04-04 22:36:26 +02:00
Committing a change to `_config.yml` (or any file in your repository) will force GitHub Pages to rebuild your site with Jekyll. It should then be viewable a few seconds later at <USERNAME.github.io>.
---
Congratulations! You've successfully forked the Minimal Mistakes Jekyll theme and are up an running with GitHub Pages. Now you're ready to add some content and customize the site further.