M README.md => README.md +7 -60
@@ 6,16 6,14 @@
* Responsive templates. Looking good on mobile, tablet, and desktop.
* Gracefully degrading in older browsers. Compatible with Internet Explorer 8+ and all modern browsers.
-* Minimal embellishments. Content first; other widget nonsense never.
-* Large feature images for posts and pages.
+* Minimal embellishments -- content first.
+* Optional large feature images for posts and pages.
* Simple and clear permalink structure.
* [Custom 404 page](http://mmistakes.github.io/minimal-mistakes/404.html) to get you started.
* Stylesheets for Pygments and Coderay [syntax highlighting](http://mmistakes.github.io/minimal-mistakes/articles/code-highlighting-post/) to make your code examples look snazzy.
-General notes and suggestions for customizing Minimal Mistakes.
-
## Basic Setup for a new Jekyll site
1. [Install Bundler](http://bundler.io) `gem install bundler` and then install [Jekyll](http://jekyllrb.com) and all dependencies `bundle install`.
@@ 23,72 21,21 @@ General notes and suggestions for customizing Minimal Mistakes.
3. Clone the repo you just forked and rename it.
4. Edit `_config.yml` to personalize your site.
5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, assigning categories and tags, and other YAML data.
-6. Read the documentation below for further customization pointers and documentation.
[Demo the Theme](http://mmistakes.github.io/minimal-mistakes)
-**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you don't want on your site.
+**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you don't need.
----
+## More Theme Setup Goodness
+
+To learn more about how customize this theme, include feature images in posts, use the Grunt build scripts, and some other junk, [read up here](http://mmistakes.github.io/minimal-mistakes-theme/theme-setup/).
-## Setup for an Existing Jekyll site
-
-1. Clone the following folders: `_includes`, `_layouts`, `assets`, and `images`.
-2. Clone the following files and personalize content as need: `about.md`, `posts.md`, `index.md`, `feed.xml`, `sitemap.xml`
-3. Set the following variables in your `config.yml` file:
-
-``` yaml
-title: Site Title
-description: Describe your website here.
-disqus_shortname: shortname
-url: http://your-website.com
-
-# Owner/author information
-owner:
- name: Your Name
- avatar: avatar.jpg
- bio: "Your bio goes here. It shouldn't be super long but a good two sentences or two should suffice."
- email: you@email.com
- # Social networking links used in footer. Update and remove as you like.
- twitter:
- facebook:
- github:
- stackexchange:
- linkedin:
- instagram:
- flickr:
- tumblr:
- # For Google Authorship https://plus.google.com/authorship
- google_plus:
-
-# Analytics and webmaster tools stuff goes here
-google_analytics:
-google_verify:
-# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
-bing_verify:
-
-# Links to include in top navigation
-# For external links add external: true
-links:
- - title: Theme Setup
- url: /theme-setup/
- - title: External Link
- url: http://mademistakes.com
- external: true
-
-# http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-timezone: America/New_York
-future: true
-pygments: true
-markdown: kramdown
-
-```
---
## Questions?
-Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter [@mmistakes](http://twitter.com/mmistakes) or [file a GitHub Issue](https://github.com/mmistakes/minima-mistakes/issues/new). And if you make something cool with this theme feel free to let me know.
+Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter [@mmistakes](http://twitter.com/mmistakes) or [file a GitHub Issue](https://github.com/mmistakes/minimal-mistakes/issues/new). And if you make something cool with this theme feel free to let me know.
---
M theme-setup.md => theme-setup.md +22 -21
@@ 43,30 43,31 @@ General notes and suggestions for customizing Minimal Mistakes.
{% highlight text %}
minimal-mistakes/
├── _includes/
-| ├── _author-bio.html #bio stuff goes here
-| ├── _browser-upgrade.html #displays on IE8 and less
-| ├── _footer.html #site footer
-| ├── _head.html #site head
-| ├── _navigation.html #site top nav
-| └── _scripts.html #jQuery, plugins, GA, etc.
+| ├── _author-bio.html # bio stuff layout. pulls optional owner data from _config.yml
+| ├── _browser-upgrade.html # prompt to install a modern browser for < IE9
+| ├── _footer.html # site footer
+| ├── _head.html # site head
+| ├── _navigation.html # site top navigation
+| └── _scripts.html # site scripts
├── _layouts/
-| ├── home.html #homepage layout
-| ├── page.html #page layout
-| ├── post-index.html #post index layout
-| └── post.html #post layout
-├── _posts/
+| ├── home.html # homepage layout
+| ├── page.html # page layout
+| ├── post-index.html # post index layout
+| └── post.html # single post layout
+├── _posts/ # MarkDown formatted posts
├── assets/
-| ├── css/ #preprocessed less styles
-| ├── fonts/ #icon webfonts
+| ├── css/ # site stylesheets
+| ├── fonts/ # webfonts
| ├── js/
-| | ├── _main.js #Main JavaScript file, plugin settings, etc
-| | ├── plugins #jQuery plugins
-| | └── vendor/ #jQuery and Modernizr
+| | ├── _main.js # main JavaScript file, plugin settings, etc
+| | ├── plugins/ # scripts and jQuery plugins to combine with _main.js
+| | ├── scripts.min.js # concatenated and minified _main.js + plugin scripts
+| | └── vendor/ # vendor scripts to leave alone and load as is
| └── less/
-├── images/ # images for posts and pages
-├── about.md # about page
-├── posts.md # lists all posts from latest to oldest
-└── index.md # homepage. lists 5 most recent posts
+├── images/ # images for posts and pages
+├── about.md # sample about page
+├── posts.md # sample post index page. lists all posts in reverse chronology
+└── index.md # sample homepage. lists 5 latest posts
{% endhighlight %}
---
@@ 75,7 76,7 @@ minimal-mistakes/
### _config.yml
-Most of the variables found here are used in the .html files found in `_includes` if you need to add or remove anything. A good place to start would be to change the title, tagline, description, and url of your site. When working locally comment out `url` or else you will get a bunch of broken links because they are absolute and prefixed with `{{ "{{ site.url " }}}}`[^1] in the various `_includes` and `_layouts`. Just remember to uncomment `url` when building for deployment or pushing to **gh-pages**...
+Most of the variables found here are used in the .html files found in `_includes` if you need to add or remove anything. A good place to start would be to change the `title`, `description`, and `url` of your site. When working locally use `http://localhost:4000` or comment out `url` to avoid broken links prefixed with `{{ "{{ site.url " }}}}`[^1] in the various `_includes` and `_layouts`. Just remember to set `url` back to the live domain before deploying or pushing to GitHub Pages.
#### Owner/Author Information