You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
1
# Beautiful Jekyll
2
2
3
-
**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 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).
3
+
**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).
4
4
5
-
Feel free to modify this in any way you'd like, but I would appreciate it if you don't remove the attribution to Beautiful Jekyll. I've noticed that many people copy this website and deliberately remove the tiny phrase that gives me credit, and it feels a bit sad to not get credit for the countless hours I've put into this. Don't make me sad!
6
-
7
-
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 with a small donation](http://deanattali.com/aboutme#feed-meeee) if you want to make me extra happy. :)
5
+
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. :)
8
6
9
7
This template is built on top of [Jekyll](http://jekyllrb.com/) and can be used for any [GitHub Pages](https://pages.github.com/) website. (If you don't know what these two things are, that's absolutely fine, you don't need to!)
10
8
@@ -124,7 +122,7 @@ subtitle | Short description of page or blog post that goes under the title
124
122
bigimg | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see [my personal website](http://deanattali.com/) as an example).
125
123
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.
126
124
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`.
127
-
fb-img | If you want to share a page on Facebook, by default Facebook will use the first image it can find on the page. If you want to specify an image to use when sharing the page on Facebook, then provide the image's URL here
125
+
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.
128
126
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)
129
127
js | List of local JavaScript files to include in the page (eg. `/js/mypage.js`)
130
128
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`)
@@ -152,7 +150,7 @@ I wrote [a blog post](http://deanattali.com/2015/03/12/beautiful-jekyll-how-to-b
152
150
153
151
### Featured users (success stories!)
154
152
155
-
To my huge surprise, Beautiful Jekyll has been used in over 500 websites in its first 6 months. Here is a hand-picked selection of some websites that use Beautiful Jekyll.
153
+
To my huge surprise, Beautiful Jekyll has been used in over 500 websites in its first 6 months alone! Here is a hand-picked selection of some websites that use Beautiful Jekyll.
156
154
157
155
Want your website featured here? [Contact me](http://deanattali.com/aboutme#contact) to let me know about your website.
158
156
@@ -169,6 +167,7 @@ Want your website featured here? [Contact me](http://deanattali.com/aboutme#cont
169
167
|[organicrails.github.io](http://organicrails.github.io)| Ruby on Rails tutorial |
170
168
|[esentire.github.io](https://esentire.github.io)| Blog about threats and malware |
171
169
|[reactionic.github.io](http://reactionic.github.io)| Create iOS and Android apps with React and Ionic |
|[chauff.github.io](http://chauff.github.io/)| Claudia Hauff | Professor at Delft University of Technology |
185
184
|[kootenpv.github.io](http://kootenpv.github.io/)| Pascal van Kooten | Data analytics |
186
-
185
+
|[sjackman.ca](http://sjackman.ca)| Shaun Jackman | PhD candidate in bioinformatics |
187
186
188
187
### Very advanced: Local development
189
188
190
-
Beautiful Jekyll is meant to be so simple to use that you can do it all within the browser. However, if you'd like to develop locally on your own machine, that's possible too if you're comfortable with command line. Folow these simple steps to do that with Vagrant:
189
+
Beautiful Jekyll is meant to be so simple to use that you can do it all within the browser. However, if you'd like to develop locally on your own machine, that's possible too if you're comfortable with command line. Follow these simple steps to do that with Vagrant:
191
190
192
191
1. Install [VirtualBox](http://virtualbox.org) and [Vagrant](https://www.vagrantup.com)
193
192
2. Clone your fork `git clone git@github.com:yourusername/yourusername.github.io.git`
@@ -197,6 +196,8 @@ Beautiful Jekyll is meant to be so simple to use that you can do it all within t
197
196
198
197
Disclaimer: I personally am NOT using local development so I don't know much about running Jekyll locally. If you follow this route, please don't ask me questions because unfortunately I honestly won't be able to help!
199
198
199
+
Additionally, if you choose to deploy Jekyll using a local ruby installation, you can tell Jekyll to automatically categorize your blog posts by tags. You just need to set `link-tags: true` in `_config.yml`. Jekyll will then generate a new page for each unique tag which lists all of the posts that belong to that tag.
200
+
200
201
### Credits
201
202
202
203
This template was not made entirely from scratch. I would like to give special thanks to:
Piracy is typically an act of robbery or criminal violence at sea. The term can include acts committed on land, in the air, or in other major bodies of water or on a shore. It does not normally include crimes committed against persons traveling on the same vessel as the perpetrator (e.g. one passenger stealing from others on the same vessel). The term has been used throughout history to refer to raids across land borders by non-state agents.
7
+
Piracy is typically an act of robbery or criminal violence at sea. The term can include acts committed on land, in the air, or in other major bodies of water or on a shore. It does not normally include crimes committed against persons traveling on the same vessel as the perpetrator (e.g. one passenger stealing from others on the same vessel). The term has been used throughout history to refer to raids across land borders by non-state agents.
What is it with that Mary girl? Dragging me to school every day. As if I had a choice. What you don't hear in those nursery rhymes is that she starves me if I don't go to school with her; it's the only way I can stay alive! I'm thinking about being adopted by Little Bo Peep, sure I may get lost, but anything is better than being with Mary and those little brats at school (shudder, shudder).
7
+
What is it with that Mary girl? Dragging me to school every day. As if I had a choice. What you don't hear in those nursery rhymes is that she starves me if I don't go to school with her; it's the only way I can stay alive! I'm thinking about being adopted by Little Bo Peep, sure I may get lost, but anything is better than being with Mary and those little brats at school (shudder, shudder).
0 commit comments