diff --git a/.gitignore b/.gitignore index 6a4e31c..1701816 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ _site *.sublime-project *.sublime-workspace codekit-config.json +node_modules Gemfile.lock \ No newline at end of file diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..c7fe066 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,20 @@ +{ + "bitwise": true, + "browser": true, + "curly": true, + "eqeqeq": true, + "eqnull": true, + "es5": false, + "esnext": true, + "immed": true, + "jquery": true, + "latedef": true, + "newcap": true, + "noarg": true, + "node": true, + "strict": false, + "trailing": false, + "undef": true, + "multistr": true, + "expr": true +} \ No newline at end of file diff --git a/Gruntfile.js b/Gruntfile.js new file mode 100644 index 0000000..a55f6d8 --- /dev/null +++ b/Gruntfile.js @@ -0,0 +1,106 @@ +'use strict'; +module.exports = function(grunt) { + + grunt.initConfig({ + jshint: { + options: { + jshintrc: '.jshintrc' + }, + all: [ + 'Gruntfile.js', + 'assets/js/*.js', + 'assets/js/plugins/*.js', + '!assets/js/scripts.min.js' + ] + }, + recess: { + dist: { + options: { + compile: true, + compress: true + }, + files: { + 'assets/css/main.min.css': [ + 'assets/less/main.less' + ] + } + } + }, + uglify: { + dist: { + files: { + 'assets/js/scripts.min.js': [ + 'assets/js/plugins/*.js', + 'assets/js/_*.js' + ] + } + } + }, + imagemin: { + dist: { + options: { + optimizationLevel: 7, + progressive: true + }, + files: [{ + expand: true, + cwd: 'images/', + src: '{,*/}*.{png,jpg,jpeg}', + dest: 'images/' + }] + } + }, + svgmin: { + dist: { + files: [{ + expand: true, + cwd: 'images/', + src: '{,*/}*.svg', + dest: 'images/' + }] + } + }, + watch: { + less: { + files: [ + 'assets/less/*.less' + ], + tasks: ['recess'] + }, + js: { + files: [ + '<%= jshint.all %>' + ], + tasks: ['uglify'] + } + }, + clean: { + dist: [ + 'assets/css/main.min.css', + 'assets/js/scripts.min.js' + ] + } + }); + + // Load tasks + grunt.loadNpmTasks('grunt-contrib-clean'); + grunt.loadNpmTasks('grunt-contrib-jshint'); + grunt.loadNpmTasks('grunt-contrib-uglify'); + grunt.loadNpmTasks('grunt-contrib-watch'); + grunt.loadNpmTasks('grunt-recess'); + grunt.loadNpmTasks('grunt-contrib-imagemin'); + grunt.loadNpmTasks('grunt-svgmin'); + + // Register tasks + grunt.registerTask('default', [ + 'clean', + 'recess', + 'uglify', + 'imagemin', + 'svgmin' + ]); + grunt.registerTask('dev', [ + 'watch' + ]); + +}; \ No newline at end of file diff --git a/README.md b/README.md index 3aac2fe..426f131 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,20 @@ 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. -* Gracefully degrading in older browsers. Compatible with Internet Explorer 8+ and all modern browsers. -* Minimal embellishments and subtle animations. +* 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. -* Simple and clear permalink structure. +* 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](http://mmistakes.github.io/so-simple-theme/404.html) to get you started. +* 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. +* Simple search. +* Grunt build script for easier theme development. ![screenshot of So Simple Theme](http://mmistakes.github.io/so-simple-theme/images/so-simple-theme-preview.jpg) -## [Preview the Theme](http://mmistakes.github.io/so-simple-theme) - General notes and suggestions for customizing So Simple Theme. --- @@ -25,11 +27,13 @@ General notes and suggestions for customizing So Simple Theme. 1. [Install Jekyll](http://jekyllrb.com) and read through the documentation if you haven't already. 2. Fork the [So Simple Theme repo](https://github.com/mmistakes/so-simple-theme/fork) -3. Clone the repo you just forked to your computer. +3. Clone the repo you just forked. 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. +[Download the Theme](http://mmistakes.github.io/so-simple-theme) + **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. --- @@ -37,7 +41,7 @@ General notes and suggestions for customizing So Simple Theme. ## Setup for 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`, `articles.html`, `index.html`, `tags.html`, and `feed.xml`. +2. Clone the following files and personalize content as need: `about.md`, `articles.html`, `index.html`, `tags.html`, `feed.xml`, and `sitemap.xml`. 3. Set the following variables in your `config.yml` file: ``` yaml @@ -45,6 +49,7 @@ title: Site Title description: Site description for the metas. logo: site-logo.png disqus_shortname: shortname +search: true #Comment out url when working locally to resolve base urls correctly url: http://whatever.com @@ -95,182 +100,39 @@ permalink: /:categories/:title ``` bash so-simple-theme/ -├── _includes -| ├── browser-upgrade.html //prompt to upgrade browser on < IE8 -| ├── footer.html //site footer -| ├── head.html //site head -| ├── navigation.html //site navigation and masthead -| └── scripts.html //jQuery, plugins, GA, etc. -├── _layouts -| ├── page.html //page layout -| └── post.html //post layout -├── _posts -├── assets -| ├── css //preprocessed less styles. good idea to minify -| ├── js -| | ├── main.js //jQuery plugins and settings -| | └── vendor //all 3rd party scripts -| └── less -├── images //images for posts and pages -├── _config.yml //Site options -├── about.md //about page -├── articles.html //lists all posts from latest to oldest -├── index.html //homepage. lists 10 latest posts -└── tags.html //lists all posts sorted by tag +├── _includes/ +| ├── browser-upgrade.html #prompt to upgrade browser on < IE8 +| ├── footer.html #site footer +| ├── head.html #site head +| ├── navigation.html #site navigation and masthead +| └── scripts.html #jQuery, plugins, GA, etc. +├── _layouts/ +| ├── page.html #page layout +| └── post.html #post layout +├── _posts/ +├── assets/ +| ├── css/ #preprocessed less styles +| ├── fonts/ #icon webfonts +| ├── js/ +| | ├── _main.js #main JavaScript file, plugin settings, etc +| | ├── plugins #jQuery plugins +| | └── vendor/ #jQuery and Modernizr +| └── less/ +├── images #images for posts and pages +├── _config.yml #Jekyll site options +├── about.md #about page +├── articles.md #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 ``` --- ## Customization -### _config.yml +For full customization details and more information on the theme check out the [So Simple theme setup guide](http://mmistakes.github.io/so-simple-theme/theme-setup/). -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, logo (or avatar photo), 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 }}` in the various `_includes` and `_layouts`. Just remember to uncomment `url` when building for deployment or pushing to **gh-pages**... - -#### Disqus Comments - -Create a [Disqus](http://disqus.com) account and change `disqus_shortname` in `_config.yml` to the Disqus *shortname* you just setup. To enable commenting on a post, add the following to its front matter: - -``` yaml -comments: true -``` - -#### Owner/Author Information - -Change your name, and avatar photo (crop it square at 200x200 or larger), email, and social networking urls. If you want to link to an external image on Gravatar or something similiar you'll need to edit the path in `head.html` since it assumes it is located in `/images`. - -Including a link to your Google+ profile has the added benefit of displaying [Google Authorship](https://plus.google.com/authorship) in Google search results if you've went ahead and applied for it. - -#### Google Analytics and Webmaster Tools - -Your Google Analytics ID goes here along with meta tags for [Google Webmaster Tools](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=35179) and [Bing Webmaster Tools](https://ssl.bing.com/webmaster/configure/verify/ownershi) site verification. - -#### Top Navigation Links - -Edit page/post titles and URLs to include in the site's navigation. For external links add `external: true`. - -``` yaml -# sample top navigation links -links: - - title: About Page - url: /about - - title: Articles - url: /articles - - title: Other Page - url: /other-page - - title: External Link - url: http://mademistakes.com - external: true -``` - -#### Other Stuff - -The rest is just your average Jekyll config settings. Nothing too crazy here... - -### _includes - -For the most part you can leave these as is since the author/owner details are pulled from `_config.yml`. That said you'll probably want to customize the copyright stuff in `footer.html` to your liking. - -### Adding Posts and Pages - -There are two main content layouts: `post.html` (for posts) and `page.html` (for pages). Both have support for large **feature images** that span the full-width of the screen, and both are meant for text heavy blog posts (or articles). - -#### Feature Images - -A good rule of thumb is to keep feature images nice and wide so you don't push the body text too far down. An image cropped around around 1024 x 256 pixels will keep file size down with an acceptable resolution for most devices. If you want to serve these images responsively I'd suggest looking at [Picturefill](https://github.com/scottjehl/picturefill) or [Adaptive Images](http://adaptive-images.com/). - -The two layouts make the assumption that the feature images live in the *images* folder. To add a feature image to a post or page just include the filename in the front matter like so. - -``` yaml -image: - feature: feature-image-filename.jpg - thumb: thumbnail-image.jpg #keep it square 200x200 px is good -``` - -If you want to apply attribution to a feature image use the following YAML front matter on posts or pages. Image credits appear directly below the feature image with a link back to the original source. - -``` yaml -image: - feature: feature-image-filename.jpg - credit: Michael Rose #name of the person or site you want to credit - creditlink: http://mademistakes.com #url to their site or licensing -``` - -#### Categories - -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`. - -If done correctly `/blog` should be a page listing all the site's posts. - -#### Post/Page Thumbnails for OG and Twitter Cards - -Post and page thumbnails work the same way. These are used by [Open Graph](https://developers.facebook.com/docs/opengraph/) and [Twitter Cards](https://dev.twitter.com/docs/cards) meta tags found in `head.html`. If you don't assign a thumbnail the image you assigned to `site.owner.avatar` in `_config.yml` will be used. - -#### Videos - -Video embeds are responsive and scale with the width of the main content block with the help of [FitVids](http://fitvidsjs.com/). - -Not sure if this only effects Kramdown or if it's an issue with Markdown in general. But adding YouTube video embeds causes errors when building your Jekyll site. To fix add a space between the ` -``` - -#### Twitter Cards - -Twitter cards make it possible to attach images and post summaries to Tweets that link to your content. Summary Card meta tags have been added to `head.html` to support this, you just need to [validate and apply your domain](https://dev.twitter.com/docs/cards) to turn it on. - -Here's an example of what a tweet to your site could look like if you activate Twitter Cards and include all the metas in your post's YAML. - -![Twitter Card summary large image screenshot](http://mmistakes.github.io/so-simple-theme/images/twitter-card-summary-large-image.jpg) - -#### Link Post Type - -So Simple Theme now supports **link posts**, made famous by John Gruber. To activate just add `link: http://url-you-want-linked` to the post's YAML front matter and you're done. - ---- - -## Further Customization - -To make things easier I use LESS to build So Simple Theme's stylesheets. If you want to make some minor cosmetic alterations, take a look at `variables.less` in `assets/less/`. Changing some of the following variables can help make the theme your own. Just compile `main.less` using your preprocessor of choice and off you go -- I like [CodeKit](http://incident57.com/codekit/) for OS X and [Prepros](http://alphapixels.com/prepros/) for Windows. - -``` css -// Typography -// -------------------------------------------------- -@base-font: 'source-sans-pro', sans-serif; -@heading-font: @base-font; -@caption-font: @base-font; -@code-font: 'source-code-pro', monospace; -@alt-font: 'volkorn', serif; - -@doc-font-size: 16; -@doc-line-height: 24; - -// Colors -// -------------------------------------------------- -@body-color : #ebebeb; -@text-color : #333; -@base-color : #343434; -@comp-color : spin(@base-color, 180); -@border-color : @base-color; -@white : #fff; -@black : #000; -@accent-color : @black; -@link-color : #343434; -``` - ---- - -## Creating a new Post - -You can create a new post like this: - -```bash -$ thor post:new 'My cool post' - create _posts/2013-08-21-my-cool-post -``` --- ## Questions? diff --git a/_config.yml b/_config.yml index ae76a85..8d2bbce 100644 --- a/_config.yml +++ b/_config.yml @@ -2,6 +2,7 @@ title: Site Title description: Describe your website here. logo: site-logo.png disqus_shortname: +search: true #Comment out url when working locally to resolve base urls correctly url: http://your-website.com @@ -65,4 +66,4 @@ kramdown: coderay_css: class include: [".htaccess"] -exclude: ["lib", "config.rb", "Capfile", "config", "log", "Rakefile", "Rakefile.rb", "tmp", "less", "*.sublime-project", "*.sublime-workspace", "test", "spec"] \ No newline at end of file +exclude: ["lib", "config.rb", "Capfile", "config", "log", "Rakefile", "Rakefile.rb", "tmp", "less", "*.sublime-project", "*.sublime-workspace", "test", "spec", "Gruntfile.js", "package.json", "node_modules"] \ No newline at end of file diff --git a/_includes/head.html b/_includes/head.html index b65360c..99d19fc 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -34,7 +34,7 @@ - + diff --git a/_includes/navigation.html b/_includes/navigation.html index 23783d8..25795f6 100644 --- a/_includes/navigation.html +++ b/_includes/navigation.html @@ -10,11 +10,22 @@ {% endif %} {% endfor %} -
  • Feed +
  • Feed
    • + {% if site.search %}
  • Search
    • {% endif %} +{% include browser-upgrade.html %} + +{% if site.search %}
    +
    + + + +
    +
    {% endif %} + {% if page.image.feature %}
    diff --git a/_includes/scripts.html b/_includes/scripts.html index 6b4a6a8..9c2c7d3 100644 --- a/_includes/scripts.html +++ b/_includes/scripts.html @@ -1,6 +1,6 @@ - + {% if site.google_analytics %}