diff --git a/README.md b/README.md index bcd47c0..69ee0ff 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,11 @@ Looking for a simple, responsive, theme for your Jekyll powered blog? Well look ## So Simple Theme is all about: * Responsive templates. Looking good on mobile, tablet, and desktop. +* Readable typography to make your words shine. * Gracefully degrading in older browsers. Compatible with Internet Explorer 9+ and all modern browsers. * Minimal embellishments and subtle animations. -* Readable typography to make your words shine. * Support for large images to call out your favorite posts. * Disqus comments if you choose to enable. -* Simple and clear permalink structure[^1]. * Tags for [Open Graph](https://developers.facebook.com/docs/opengraph/) and [Twitter Cards](https://dev.twitter.com/docs/cards) for a better social sharing experience. * Vanilla [custom 404 page]({{ site.url }}/404.html) to get you started. * Stylesheets for Pygments and Coderay [syntax highlighting](http://mmistakes.github.io/articles/so-simple-theme/code-highlighting-post/) to make your code examples look snazzy. @@ -94,7 +93,7 @@ pygments: true markdown: kramdown # https://github.com/mojombo/jekyll/wiki/Permalinks -permalink: /:categories/:title +permalink: /:categories/:title/ ``` --- @@ -124,7 +123,7 @@ so-simple-theme/ ├── images #images for posts and pages ├── _config.yml #Jekyll site options ├── about.md #about page -├── articles.md #lists all posts from latest to oldest +├── articles.html #lists all posts from latest to oldest ├── index.html #homepage. lists 10 latest posts ├── tags.html #lists all posts sorted by tag └── sitemap.xml #autogenerated sitemap for search engines diff --git a/theme-setup.md b/theme-setup.md index 7f1a8f3..89a0cc2 100644 --- a/theme-setup.md +++ b/theme-setup.md @@ -9,6 +9,9 @@ tags: [Jekyll, theme, install, setup] General notes and suggestions for customizing **So Simple Theme**. +* Table of Contents +{:toc} + ## Basic Setup for a new Jekyll site 1. [Install Jekyll](http://jekyllrb.com) and read through the documentation if you haven't already. @@ -67,9 +70,9 @@ bing_verify: # For external links add external: true links: - title: About - url: /about + url: /about/ - title: Articles - url: /articles + url: /articles/ - title: Google url: http://google.com external: true @@ -80,7 +83,7 @@ pygments: true markdown: kramdown # https://github.com/mojombo/jekyll/wiki/Permalinks -permalink: /:categories/:title +permalink: /:categories/:title/ {% endhighlight %} --- @@ -110,7 +113,7 @@ so-simple-theme/ ├── images #images for posts and pages ├── _config.yml #Jekyll site options ├── about.md #about page -├── articles.md #lists all posts from latest to oldest +├── articles.html #lists all posts from latest to oldest ├── index.html #homepage. lists 10 latest posts ├── tags.html #lists all posts sorted by tag └── sitemap.xml #autogenerated sitemap for search engines @@ -149,11 +152,11 @@ Edit page/post titles and URLs to include in the site's navigation. For external # sample top navigation links links: - title: About Page - url: /about + url: /about/ - title: Articles - url: /articles + url: /articles/ - title: Other Page - url: /other-page + url: /other-page/ - title: External Link url: http://mademistakes.com external: true @@ -209,9 +212,12 @@ image: In the sample `_posts` folder you may have noticed `category: articles` in the front matter. I like keeping all posts grouped in the same folder. If you decide to rename or add categories you will need to modify the permalink in `articles.md` along with the filename (if renaming). -For example. Say you want to group all your posts under `blog/` instead of `articles/`. In your post add `category: blog` to the front matter, rename or duplicate `articles.md` to `blog.md` and change the permalink in that file to `permalink: /blog/index.html`. +For example. Say you want to group all your posts under `blog/` instead of `articles/`. In your post add `category: blog` to the front matter, rename or duplicate `articles.html` to `blog.html` and change the permalink in that file to `permalink: /blog/`. -If done correctly `/blog` should be a page listing all the site's posts. +If done correctly `/blog/` should be a page listing all of the site's posts. + +**ProTip:** To create multiple category pages, listing posts assigned to just that category modify the `for post` loop found in `articles.html` to something like `{{ "{% for post in site.categories.articles " }}%}`. Just be careful if you decide to paginate this page, Jekyll won't limit it to the category and will pull from all of your posts unless you use a plugin or a mess of Liquid if statements. +{: .notice} #### Post/Page Thumbnails for OG and Twitter Cards