From 181ac73615e752c5e949388e603225d3cf0dffd8 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Tue, 29 Mar 2016 16:53:39 -0400 Subject: [PATCH] Update docs --- _docs/docs-2.md | 8 +++--- _docs/installation.md | 50 ++++++++++++++++++++++++++++++++++++++ _docs/quick-start-guide.md | 12 ++++++++- 3 files changed, 64 insertions(+), 6 deletions(-) create mode 100644 _docs/installation.md diff --git a/_docs/docs-2.md b/_docs/docs-2.md index 097e4b65..728c1690 100644 --- a/_docs/docs-2.md +++ b/_docs/docs-2.md @@ -35,17 +35,15 @@ If you want to use Minimal Mistakes with an existing Jekyll site follow these st ## Running Jekyll -The preferred method for running Jekyll is with `bundle exec`, but if you're willing to deal gem conflicts feel free to go cowboy with a `jekyll build` or `jekyll serve`. +The preferred method for running Jekyll is with `bundle exec`, but if you're willing to deal gem conflicts feel free to go cowboy with a `jekyll serve` or `jekyll build`. > In some cases, running executables without bundle exec may work, if the executable happens to be installed in your system and does not pull in any gems that conflict with your bundle. > >However, this is unreliable and is the source of considerable pain. Even if it looks like it works, it may not work in the future or on another machine. -{% highlight text %} -bundle exec jekyll build - +```bash bundle exec jekyll serve -{% endhighlight %} +``` --- diff --git a/_docs/installation.md b/_docs/installation.md new file mode 100644 index 00000000..9011c582 --- /dev/null +++ b/_docs/installation.md @@ -0,0 +1,50 @@ +--- +title: "Installation" +excerpt: +sidebar: + nav: docs +--- + +{% include base_path %} +{% include toc %} + +Minimal Mistakes has been developed to be 100% compatible with sites hosted on GitHub Pages. To get up and running with a new GitHub repository following these steps. + +## Fork Minimal Mistakes + +[Fork this repo](https://github.com/mmistakes/minimal-mistakes/fork), then rename it to **_yourgithubusername_.github.io** + +Your Jekyll based site should then be viewable at --- if it's not, you can force it to build by adding and publishing your a post (see below). + +## Install Dependencies + +If this is your first time using Jekyll be sure to read through the [official documentation](https://jekyllrb.com/docs/home/) to familiarize yourself. This guide assumes you've done that and have Ruby v2 installed. + +To keep your sanity and better manage dependencies I strongly urge you to [install Bundler](http://bundler.io/) with `gem install bundler` and use the included [`Gemfile`](https://github.com/mmistakes/minimal-mistakes/blob/master/Gemfile). + +```bash +$ bundle install +``` + +Depending on what gems you already have installed you may have to run `bundle update` to clear up any dependency issues. Bundler is usually pretty good at letting you know what the issue is to work through them. + +## Customize Your Site + +Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too. + +Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at http://yourgithubusername.github.io - if not, give it ten minutes as GitHub suggests and it'll appear soon + +There are 3 different ways that you can make changes to your blog's files: + +Edit files within your new username.github.io repository in the browser at GitHub.com (shown below). +Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy. +Clone down your repository and make updates locally, then push them to your GitHub repository. +_config.yml + +Step 3) Publish your first blog post + +Edit /_posts/2014-3-3-Hello-World.md to publish your first blog post. This Markdown Cheatsheet might come in handy. + +First Post + +You can add additional posts in the browser on GitHub.com too! Just hit the + icon in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md \ No newline at end of file diff --git a/_docs/quick-start-guide.md b/_docs/quick-start-guide.md index 6f907150..b2656946 100644 --- a/_docs/quick-start-guide.md +++ b/_docs/quick-start-guide.md @@ -5,4 +5,14 @@ sidebar: nav: docs --- -Blah blah. \ No newline at end of file +{% include base_path %} + +Minimal Mistakes has been developed to be 100% compatible with GitHub Pages hosting. To get up and running with a new GitHub repository following these steps. + +1. Fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork) and then rename the repo to **_USERNAME_.github.io** +2. Clone your new repo with `git clone https://github.com/USERNAME/REPONAME.git` +3. [Install Bundler](http://bundler.io) and theme dependencies with `bundle install`. +4. Customize configuration, data files, and publish your first post. + +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 **yourgithubusername.github.io** and use the `gh-pages` branch instead of `master`. For more details check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/). +{: .notice--info} \ No newline at end of file