diff --git a/README.md b/README.md index 043bb09..62fe643 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Beautiful Jekyll -**Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal blogs or simple project websites. [Check out a demo](http://deanattali.com/beautiful-jekyll) of what you'll get after just two minutes. You can also look at [my personal website](http://deanattali.com) to see it in use, or see examples of websites other people created using this theme [here](#featured-users-success-stories). +> *Copyright 2016 [Dean Attali](http://deanattali.com). Licensed under the MIT license.* + +**Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal blogs or simple project websites. [Check out a demo](http://deanattali.com/beautiful-jekyll) of what you'll get after just two minutes. You can also look at [my personal website](http://deanattali.com) to see it in use, or see examples of websites other people created using thcois theme [here](#featured-users-success-stories). If you need a bit of help or have comments, feel free to [contact me](http://deanattali.com/aboutme#contact). Even if you don't have anything important to say but found this useful, I'd love to [hear about it](http://deanattali.com/aboutme#contact). Lastly, if you like this theme, please consider [supporting me](https://www.paypal.me/daattali/20) if you want to make me extra happy. :) @@ -102,7 +104,11 @@ If the `disqus` parameter is set in the configuration file, then all blog posts #### Adding Google Analytics to track page views -Beautiful Jekyll lets you easily add Google Analytics to all your pages. This will let you track all sorts of information about visits to your website, such as how many times each page is viewed and where (geographically) your users come from. To add Google Analytics, simply sign up to [Google Analytics](http://www.google.com/analytics/) to obtain your Google Tracking ID, and add this tracking ID to the `google_analytics` parameter in `_config.yml`. +Beautiful Jekyll lets you easily add Google Analytics to all your pages. This will let you track all sorts of information about visits to your website, such as how many times each page is viewed and where (geographically) your users come from. To add Google Analytics, simply sign up to [Google Analytics](http://www.google.com/analytics/) to obtain your Google Tracking ID, and add this tracking ID to the `google_analytics` parameter in `_config.yml`. + +#### Sharing blog posts on social media + +By default, all blog posts will have buttons at the bottom of the post to allow people to share the current page on Twitter/Facebook/LinkedIn. You can choose to enable/disable specific social media websites in the `_config.yml` file. You can also turn off the social media buttons on specific blog posts using `social-share: false` in the YAML front matter. #### Page types @@ -123,6 +129,7 @@ bigimg | Include a large full-width image at the top of the page. You can comments | If you want do add Disqus comments to a specific page, use `comments: true`. Comments are automatically enabled on blog posts; to turn comments off for a specific post, use `comments: false`. Comments only work if you set your Disqus id in the `_config.yml` file. show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`. If you want to turn it off by default, locate the line `show-avatar: true` in the file `_config.yml` and change the `true` to `false`; then you can selectively turn it on in specific pages using `show-avatar: true`. share-img | If you want to specify an image to use when sharing the page on Facebook or Twitter, then provide the image's full URL here. +social-share | If you don't want to show buttons to share a blog post on social media, use `social-share: false` (this feature is turned on by default). layout | What type of page this is (default is `blog` for blog posts and `page` for other pages. You can use `minimal` if you don't want a header and footer) js | List of local JavaScript files to include in the page (eg. `/js/mypage.js`) ext-js | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`) @@ -180,7 +187,8 @@ Want your website featured here? [Contact me](http://deanattali.com/aboutme#cont | [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology | | [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics | | [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics | -| [epwalsh.fyi](https://epwalsh.fyi) | Evan Pete Walsh | PhD candidate (Statistics and Mathematics) at Iowa State University | +| [epwalsh.com](https://epwalsh.com) | Evan Pete Walsh | PhD candidate (Statistics and Mathematics) at Iowa State University | +| [otomatikmuhendis.com](http://otomatikmuhendis.com/) | Olcay Bayram | Software engineer | ### Very advanced: Local development @@ -208,7 +216,9 @@ I'd also like to thank [Dr. Jekyll's Themes](http://drjekyllthemes.github.io/), If you find anything wrong or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome! -If you do fork this project to use as a template for your site, I would appreciate if you keep the link in the footer to this project. I've noticed that several people who forked this repo removed the attribution and I would prefer to get the recognition if you do use this :) +Thank you to [all contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). Special thanks to the following people with non-trivial contributions (in chronological order): [@hristoyankov](https://github.com/hristoyankov), [@jamesonzimmer](https://github.com/jamesonzimmer), [@XNerv](https://github.com/XNerv), [@epwalsh](https://github.com/epwalsh), [@rtlee9](https://github.com/rtlee9). + +If you do fork or clone this project to use as a template for your site, I would appreciate if you keep the link in the footer to this project. I've noticed that several people who forked this repo removed the attribution and I would prefer to get the recognition if you do use this :) ### Known limitations diff --git a/_config.yml b/_config.yml index d35e187..bd8d394 100644 --- a/_config.yml +++ b/_config.yml @@ -45,8 +45,11 @@ author: github: yourname # eg. daattali twitter: yourname # eg. daattali linkedin: yourname # eg. daattali + xing: yourname # eg. daattali stackoverflow: yourlink # eg. "3943160/daattali" - + instagram: yourname # eg. daattali + youtube: yourlink # eg. user/daattali or channel/daattali + # Select which links to show in the footer footer-links-active: rss: false @@ -55,7 +58,17 @@ footer-links-active: twitter: true github: true linkedin: false + xing: false stackoverflow: false + instagram: false + youtube: false + +# Select which share links to show in posts +share-links-active: + twitter: true + facebook: true + google: false + linkedin: true # How to display the link to the website in the footer # Remove this if you don't want a link in the footer @@ -90,6 +103,7 @@ defaults: values: layout: "post" comments: true # add comments to all blog posts + social-share: true # add social media sharing buttons to all blog posts - scope: path: "" # all files diff --git a/_includes/disqus.html b/_includes/disqus.html index 510ab12..fd05ba0 100644 --- a/_includes/disqus.html +++ b/_includes/disqus.html @@ -3,7 +3,7 @@