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
+51-25Lines changed: 51 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -117,37 +117,14 @@ author:
117
117
118
118
Remove the lines that you don't want to display in the footer, and change `yourname` to the correct values in the links you want to keep.
119
119
120
-
### Buttons for sharing blog posts on social media
120
+
#### Add your website's name to the footer
121
121
122
-
By default, every blog post will have buttons atthebottom for sharing the page on Twitter, Facebook, LinkedIn, and Google+. If you want to disable these buttons, add these lines to your `_config.yml`:
122
+
After allthecontact info links, you can also add the name of your website by defining the` url-pretty` parameter in `_config.yml`:
123
123
124
124
```yaml
125
-
share-links-active:
126
-
twitter: false
127
-
facebook: false
128
-
google: false
129
-
linkedin: false
130
-
```
131
-
132
-
These settings will remove all four buttons. You can use `true` instead of `false` for any buttons that you want to keep.
133
-
134
-
135
-
136
-
```
137
125
url-pretty: "MyWebsite.com
138
126
```
139
127
140
-
```
141
-
disqus: ""
142
-
```
143
-
144
-
```
145
-
google_analytics
146
-
```
147
-
148
-
149
-
150
-
151
128
### Adding an index page
152
129
153
130
Feel free to create the index page (homepage) of your site however you'd like. If you want to have an index page similar to the one at [deanattali.com](http://deanattali.com), then create `index.html` as follows:
@@ -216,6 +193,55 @@ gems:
216
193
- jekyll-paginate
217
194
```
218
195
196
+
### Buttons for sharing blog posts on social media
197
+
198
+
By default, every blog post will have buttons at the bottom for sharing the page on Twitter, Facebook, LinkedIn, and Google+. If you want to disable these buttons, add these lines to your `_config.yml`:
199
+
200
+
```yaml
201
+
share-links-active:
202
+
twitter: false
203
+
facebook: false
204
+
google: false
205
+
linkedin: false
206
+
```
207
+
208
+
These settings will remove all four buttons. You can use `true` instead of `false` for any buttons that you want to keep.
209
+
210
+
### Allowing users to leave comments
211
+
212
+
If you want to enable comments on your site, Beautiful-Jekyll supports the [Disqus](https://disqus.com/) comments plugin. To use it, simply sign up to Disqus and add your Disqus shortname (**not** the userid) to the `disqus` parameter in `_config.yml`:
213
+
214
+
```yaml
215
+
disqus: yourshortname
216
+
```
217
+
218
+
### Adding Google Analytics to track page views
219
+
220
+
Beautiful-Jekyll lets you easily add Google Analytics to all your pages. This will allow you to 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`:
221
+
222
+
```yaml
223
+
google_analytics: yourid
224
+
```
225
+
226
+
### YAML parameter you can use to personalize each page
227
+
228
+
These are all the parameters you can place inside a page's YAML front matter that Beautiful-Jekyll supports.
229
+
230
+
Parameter | Description
231
+
----------- | -----------
232
+
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).
233
+
title | Page or blog post title.
234
+
subtitle | Short description of page or blog post that goes under the title.
235
+
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).
236
+
comments | Only applicable if the `disqus` parameter is set in the `config_yml` file. All blog posts automatically have comments enabled. To enable comments on a specific page, use `comments:true`; to turn comments off for a specific blog post, use `comments: false`.
237
+
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).
238
+
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.
239
+
js | List of local JavaScript files to include in the page (eg. `/js/mypage.js`)
240
+
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`)
241
+
css | List of local CSS files to include in the page
242
+
ex-css | List of external CSS files to include in the page
243
+
googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`)
244
+
219
245
## Contributions
220
246
221
247
If you find anything wrong or would like to contribute in any way, feel free to submit a pull request/open an issue [on GitHub](https://github.com/daattali/beautiful-jekyll), or [send me a message](http://deanattali.com/contact).