diff --git a/_docs/01-quick-start-guide.md b/_docs/01-quick-start-guide.md index fa77ab70..6ae48194 100644 --- a/_docs/01-quick-start-guide.md +++ b/_docs/01-quick-start-guide.md @@ -15,20 +15,27 @@ Minimal Mistakes has been developed to be 100% compatible with hosting a site on Fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username. -**<< insert animation showing how to fork GitHub repo >>** +
+ fork Minimal Mistakes +
Your Jekyll site should be viewable immediately at . If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details). {: .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/). -**<< insert animation showing how create to gh-pages branch >>** +
+ creating a new branch on GitHub +
## 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. -**<< insert animation showing how to edit the site title >>** +
+ editing _config.yml file +
Edit text files without leaving GitHub.com
+
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 . diff --git a/images/mm-gh-pages.gif b/images/mm-gh-pages.gif new file mode 100644 index 00000000..b831808a Binary files /dev/null and b/images/mm-gh-pages.gif differ diff --git a/images/mm-github-edit-config.gif b/images/mm-github-edit-config.gif new file mode 100644 index 00000000..12c0ea85 Binary files /dev/null and b/images/mm-github-edit-config.gif differ diff --git a/images/mm-theme-fork-repo.png b/images/mm-theme-fork-repo.png new file mode 100644 index 00000000..5f450f5e Binary files /dev/null and b/images/mm-theme-fork-repo.png differ