|
1 | | -#beautiful-jekyll |
| 1 | +#Beautiful-Jekyll Theme (beautiful-jekyll-theme gem) |
2 | 2 |
|
3 | | -Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up yourtheme into a gem. Put your layouts in`_layouts`, your includes in`_includes` and your sass in`_sass`. To experiment with this code, add some sample content and run`bundle execjekyll serve` – this directory is setup just like a Jekyll site! |
| 3 | +[](https://badge.fury.io/rb/beautiful-jekyll-theme) |
4 | 4 |
|
5 | | -TODO: Delete this and the text above, and describe your gem |
| 5 | +>*Copyright 2016[Dean Attali](http://deanattali.com). Licensed under the MIT license.* |
| 6 | +
|
| 7 | +**Beautiful-Jekyll** is a ready-to-use Jekyll theme to help you create an awesome website quickly. Perfect for personal blogs or simple project websites, with a focus on responsive and clean design. You can 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](https://github.com/daattali/beautiful-jekyll#showcased-users-success-stories). |
| 8 | + |
| 9 | +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. :) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +##Prerequisites |
| 14 | + |
| 15 | +To use this theme's gem, you need to first have a functioning Jekyll website. If you don't, there are many resources online for how to set up a Jekyll site. Here are the basic commands to get a minimal Jekyll site set up in Ubuntu: |
| 16 | + |
| 17 | +``` |
| 18 | +sudo apt-get install ruby ruby-dev make gcc |
| 19 | +sudo gem install jekyll bundler |
| 20 | +jekyll new ~/mysite |
| 21 | +``` |
6 | 22 |
|
7 | 23 | ##Installation |
8 | 24 |
|
9 | | -Addthis line to your Jekyll site's Gemfile: |
| 25 | +To use the Beautiful-Jekyll theme, addthis line to your Jekyll site's`Gemfile`: |
10 | 26 |
|
11 | 27 | ```ruby |
12 | | -gem"beautiful-jekyll" |
| 28 | +gem"beautiful-jekyll-theme" |
13 | 29 | ``` |
14 | 30 |
|
15 | | -And add this line to your Jekyll site's`_config.yml`: |
| 31 | +Then add this line to your Jekyll site's`_config.yml`: |
16 | 32 |
|
17 | 33 | ```yaml |
18 | 34 | theme:beautiful-jekyll |
19 | 35 | ``` |
20 | 36 |
|
21 | | -Andthen execute: |
| 37 | +Andfinally execute: |
22 | 38 |
|
23 | 39 | $ bundle |
24 | 40 |
|
25 | | -Or install it yourself as: |
26 | | -
|
27 | | - $ gem install beautiful-jekyll |
| 41 | +To preview your site, run`bundle exec jekyll serve` (optionally with the `--host 0.0.0.0` flag if needed) and open your browser at `http://localhost:4000`. |
28 | 42 |
|
29 | 43 | ## Usage |
30 | 44 |
|
31 | | -TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass. |
32 | 45 |
|
33 | | -## Contributing |
| 46 | +``` |
| 47 | +navbar-links: |
| 48 | + About Me: "aboutme" |
| 49 | + Resources: |
| 50 | + - Beautiful Jekyll: "http://deanattali.com/beautiful-jekyll/" |
| 51 | + - Learn markdown: "http://www.markdowntutorial.com/" |
| 52 | + - GitHub Pages: "https://pages.github.com/" |
| 53 | + Author's home: "http://deanattali.com" |
| 54 | +``` |
34 | 55 |
|
35 | | -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. |
| 56 | +``` |
| 57 | +avatar: "/img/avatar-icon.png" |
| 58 | +``` |
| 59 | +
|
| 60 | +``` |
| 61 | +author: |
| 62 | + name: Some Person |
| 63 | + email: "youremail@domain.com" |
| 64 | + facebook: yourname # eg. daattali |
| 65 | + github: yourname # eg. daattali |
| 66 | + twitter: yourname # eg. daattali |
| 67 | + reddit: yourname # eg. daattali |
| 68 | + google-plus: +yourname # eg. +DeanAttali or 109424658772469020925 |
| 69 | + linkedin: yourname # eg. daattali |
| 70 | + xing: yourname # eg. daattali |
| 71 | + stackoverflow: yourlink # eg. "3943160/daattali" |
| 72 | + snapchat: yourname # eg. daattali |
| 73 | + instagram: yourname # eg. daattali |
| 74 | + youtube: yourlink # eg. user/daattali or channel/daattali |
| 75 | + spotify: yourname # eg. daattali |
| 76 | +``` |
| 77 | +
|
| 78 | +``` |
| 79 | +#Select which share links to show in posts |
| 80 | +share-links-active: |
| 81 | + twitter: true |
| 82 | + facebook: true |
| 83 | + google: false |
| 84 | + linkedin: true |
| 85 | +``` |
36 | 86 |
|
37 | | -## Development |
| 87 | +``` |
| 88 | +url-pretty: "MyWebsite.com |
| 89 | +``` |
| 90 | +
|
| 91 | +``` |
| 92 | +disqus: "" |
| 93 | +``` |
| 94 | +
|
| 95 | +``` |
| 96 | +google_analytics |
| 97 | +``` |
| 98 | +
|
| 99 | +
|
| 100 | +``` |
| 101 | +defaults: |
| 102 | + - |
| 103 | +scope: |
| 104 | + path: "" |
| 105 | + type: "posts" |
| 106 | +values: |
| 107 | + layout: "post" |
| 108 | + - |
| 109 | +scope: |
| 110 | + path: "" # all files |
| 111 | +values: |
| 112 | + layout: "page" |
| 113 | +``` |
| 114 | +
|
| 115 | +
|
| 116 | +### Adding an index page |
| 117 | +
|
| 118 | +paginate: 5 |
| 119 | +gems: |
| 120 | + - jekyll-paginate |
| 121 | +
|
| 122 | +``` |
| 123 | +--- |
| 124 | +title: My Website |
| 125 | +subtitle: Some short description of my site |
| 126 | +--- |
| 127 | + |
| 128 | +<divclass="posts-list"> |
| 129 | + {% for post in paginator.posts %} |
| 130 | + <articleclass="post-preview"> |
| 131 | +<a href="{{ post.url }}"> |
| 132 | + <h2 class="post-title">{{ post.title }}</h2> |
| 133 | + {% if post.subtitle %} |
| 134 | + <h3 class="post-subtitle">{{ post.subtitle }}</h3> |
| 135 | + {% endif %} |
| 136 | +</a> |
| 137 | + |
| 138 | +<p class="post-meta"> |
| 139 | + Posted on {{ post.date | date: "%B %-d, %Y" }} |
| 140 | +</p> |
| 141 | + |
| 142 | +<div class="post-entry"> |
| 143 | + {{ post.excerpt | strip_html | xml_escape | truncatewords: 50 }} |
| 144 | + {% assign excerpt_word_count = post.excerpt | number_of_words %} |
| 145 | + {% if post.content != post.excerpt or excerpt_word_count > 50 %} |
| 146 | + <a href="{{ post.url }}" class="post-read-more">[Read More]</a> |
| 147 | + {% endif %} |
| 148 | +</div> |
| 149 | + |
| 150 | +{% if post.tags.size > 0 %} |
| 151 | +<div class="blog-tags"> |
| 152 | + Tags: |
| 153 | + {{ post.tags | join: ", " }} |
| 154 | +</div> |
| 155 | +{% endif %} |
| 156 | + |
| 157 | + </article> |
| 158 | + {% endfor %} |
| 159 | +</div> |
| 160 | + |
| 161 | +{% if paginator.total_pages > 1 %} |
| 162 | +<ulclass="pager main-pager"> |
| 163 | + {% if paginator.previous_page %} |
| 164 | + <liclass="previous"> |
| 165 | +<a href="{{ paginator.previous_page_path | replace: '//', '/' }}">← Newer Posts</a> |
| 166 | + </li> |
| 167 | + {% endif %} |
| 168 | + {% if paginator.next_page %} |
| 169 | + <liclass="next"> |
| 170 | +<a href="{{ paginator.next_page_path | replace: '//', '/' }}">Older Posts →</a> |
| 171 | + </li> |
| 172 | + {% endif %} |
| 173 | +</ul> |
| 174 | +{% endif %} |
| 175 | + |
| 176 | +``` |
38 | 177 |
|
39 | | -To set up your environment to develop this theme, run`bundle install`. |
| 178 | +## Contributions |
40 | 179 |
|
41 | | -Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` andopenyour browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. |
| 180 | +If you find anything wrong or would like to contribute in any way, feel free to submit a pull request/openan issue [on GitHub](https://github.com/daattali/beautiful-jekyll), or [send me a message](http://deanattali.com/contact). |
42 | 181 |
|
43 | | -When your theme is released, onlythefiles in `_layouts`, `_includes`, and `_sass` tracked with Git will be released. |
| 182 | +Thank you to [all contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). Special thanks tothefollowing 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). |
44 | 183 |
|
45 | | -##License |
| 184 | +##Credits |
46 | 185 |
|
47 | | -The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). |
| 186 | +This template was not made entirely from scratch. I would like to give special thanks to: |
| 187 | +- [Barry Clark](https://github.com/barryclark) and his project [Jekyll Now](https://github.com/barryclark/jekyll-now), from whom I've taken several ideas and code snippets, as well as some documenation tips. |
| 188 | +- [Iron Summit Media](https://github.com/IronSummitMedia) and their project [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from which I've used some design ideas and some of the templating code for posts and pagination. |
48 | 189 |
|
| 190 | +I'd also like to thank [Dr. Jekyll's Themes](http://drjekyllthemes.github.io/), [Jekyll Themes](http://jekyllthemes.org/), and another [Jekyll Themes](http://jekyllrc.github.io/jekyllthemes/) for featuring Beautiful Jekyll in their Jekyll theme directories. |