hacks-guide/minimal-mistakes
1
0
Fork 0
mirror of https://github.com/hacks-guide/minimal-mistakes.git synced 2024-11-23 16:59:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add link to MM remote theme starter

Browse Source
This commit is contained in:
Michael Rose 2019-04-18 15:54:51 -04:00
parent d90cea5ef3
commit 4e41e73558
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -128,6 +128,8 @@ To install:
4. Add `remote_theme: "mmistakes/minimal-mistakes@4.16.0"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
**Looking for an example?** Fork the [Minimal Mistakes remote theme starter](https://github.com/mmistakes/mm-github-pages-starter) for the quickest method of getting a GitHub Pages hosted site up and running. Replace sample content with your own and configure as needed.
## Usage
For detailed instructions on how to configure, customize, add/migrate content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).

5
docs/_docs/01-quick-start-guide.md
View File

@ -2,7 +2,7 @@
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
last_modified_at: 2018-11-25T22:21:33-05:00
last_modified_at: 2019-04-18T15:53:52-04:00
redirect_from:
- /theme-setup/
toc: true
@ -78,6 +78,9 @@ To install as a remote theme:
You may also optionally specify a branch, [tag](https://github.com/mmistakes/minimal-mistakes/tags), or commit to use by appending an @ and the Git ref (e.g., `mmistakes/minimal-mistakes@4.9.0` or `mmistakes/minimal-mistakes@bbf3cbc5fd64a3e1885f3f99eb90ba92af84063d`). This is useful when rolling back to older versions of the theme. If you don't specify a Git ref, the latest on `master` will be used.
**Looking for an example?** Fork the [Minimal Mistakes remote theme starter](https://github.com/mmistakes/mm-github-pages-starter) for the quickest method of getting a GitHub Pages hosted site up and running. Replace sample content with your own and configure as needed.
{: .notice--info}
---
**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).