Dean Attali committed Mar 02, 2015 1 # Beautiful Jekyll  Dean Attali committed Mar 02, 2015 2   Dean Attali committed Dec 14, 2016 3 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/daattali/20)  Dean Attali committed Dec 07, 2016 4 [![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme)  Dean Attali committed Dec 07, 2016 5   Dean Attali committed Jun 22, 2019 6 > *Copyright 2019 [Dean Attali](https://deanattali.com)*  Dean Attali committed Aug 06, 2016 7   Dean Attali committed Oct 11, 2018 8 **Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://deanattali.com/beautiful-jekyll) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) to see it in use, or see examples of websites other people created using this theme [here](#showcased-users-success-stories).  Dean Attali committed Mar 02, 2015 9   Dean Attali committed May 07, 2017 10 **If you enjoy this theme, please consider [supporting me](https://www.paypal.me/daattali/20) for developing and maintaining this template.**  Dean Attali committed Mar 27, 2016 11   Dean Attali committed Dec 14, 2016 12 
 Dean Attali committed Dec 21, 2016 13   Dean Attali committed Dec 14, 2016 14 15 16 17 
 Dean Attali committed Sep 05, 2015 18 19 20 21 22 ### Table of contents - [Prerequisites](#prerequisites) - [Build your website in 3 steps](#build-your-website-in-3-steps) - [Add your own content](#add-your-own-content)  Dean Attali committed Mar 27, 2016 23 - [Last important thing: YAML front matter ("parameters" for a page)](#last-important-thing-yaml-front-matter-parameters-for-a-page)  Dean Attali committed Oct 10, 2016 24 - [Features](#features)  Dean Attali committed Oct 10, 2016 25 - [Creating a User Page vs a Project Page](#creating-a-user-page-vs-a-project-page)  Dean Attali committed Oct 10, 2016 26 - [Showcased users (success stories!)](#showcased-users-success-stories)  Dean Attali committed Oct 10, 2016 27 - [Advanced: local development](#advanced-local-development-using-docker)  Dean Attali committed Apr 01, 2018 28 - [FAQ and support](#faq-and-support)  Dean Attali committed Oct 10, 2016 29 - [Credits and contributions](#credits)  Dean Attali committed Sep 05, 2015 30   31 32 ## Prerequisites  Vincent Tam committed Jun 28, 2019 33 - You need to have a GitHub/GitLab account. If you don't have one, [sign up here](https://github.com/join) - it takes one minute. This is where your website will live - if you sign up GitHub with username johnsmith then your website will be https://johnsmith.github.io.  Dean Attali committed Oct 11, 2018 34 - It would be helpful to understand what Markdown is and how to write it. Markdown is just a way to take a piece of text and format it to look a little nicer. For example, this whole instruction set that you're reading is written in markdown - it's just text with some words being bold/larger/italicized/etc. I recommend taking 5 minutes to learn markdown [with this amazingly easy yet useful tutorial](https://markdowntutorial.com/).  Dean Attali committed Mar 02, 2015 35   Dean Attali committed Mar 02, 2015 36 37 ## Build your website in 3 steps  Marco Blessing committed Jan 18, 2018 38 Getting started is *literally* as easy as 1-2-3 :smile:  Dean Attali committed Mar 27, 2016 39 Scroll down to see the steps involved, but here is a 40-second video just as a reference as you work through the steps.  Dean Attali committed Mar 03, 2015 40 41  ![Installation steps](img/install-steps.gif)  Dean Attali committed Mar 02, 2015 42   Marcio Mangar committed Oct 08, 2016 43 ### 1. Fork this repository  Dean Attali committed Mar 02, 2015 44   Vincent Tam committed Jun 28, 2019 45 (Assuming you are on this page and logged into GitHub/GitLab) Fork this repository by clicking the *Fork* button on the top right corner. Forking means that you now copied this whole project and all the files into your account.  Dean Attali committed Mar 02, 2015 46   Dean Attali committed Mar 27, 2016 47 ### 2. Rename the repository to .github.io  Dean Attali committed Mar 02, 2015 48   Dean Attali committed Oct 11, 2018 49 This will create a GitHub User page ready with the **Beautiful Jekyll** template that will be available at https://.github.io within a couple minutes. To do this, click on *Settings* at the top (the cog icon) and there you'll have an option to rename.  50   Vincent Tam committed Jun 28, 2019 51 52 For GitLab.com and Framagit users, replace github in https://.github.io with gitlab and frama respectively for the rest of this README.  53 ### 3. Customize your website settings  Dean Attali committed Mar 02, 2015 54   Dean Attali committed Mar 27, 2016 55 Edit the _config.yml file to change all the settings to reflect your site. To edit the file, click on it and then click on the pencil icon (watch the video tutorial above if you're confused). The settings in the file are fairly self-explanatory and I added comments inside the file to help you further. Any line that begins with a pound sign (#) is a comment, and the rest of the lines are actual settings.  Dean Attali committed Mar 02, 2015 56   Dean Attali committed Oct 11, 2018 57 Another way to edit the config file (or any other file) is to use [prose.io](https://prose.io/), which is just a simple interface to allow you to more intuitively edit files or add new files to your project.  Dean Attali committed Jun 20, 2015 58   Dean Attali committed Oct 11, 2018 59 After you save your changes to the config file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at https://.github.io. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so.  Dean Attali committed Mar 02, 2015 60   Dean Attali committed Oct 11, 2018 61 You can now visit your shiny new website, which will be seeded with several sample blog posts and a couple other pages. Your website is at https://.github.io (replace  with your user name). Do not add www to the URL - it will not work!  Dean Attali committed Mar 02, 2015 62   Dean Attali committed Jan 20, 2016 63 **Note:** The video above goes through the setup for a user with username daattalitest. I only edited one setting in the _config.yml file in the video, but **you should actually go through the rest of the settings as well. Don't be lazy, go through all the settings :)**  Dean Attali committed Mar 03, 2015 64   Dean Attali committed Oct 10, 2016 65 ## Add your own content  Dean Attali committed Mar 02, 2015 66   Dean Attali committed Oct 11, 2018 67 To add pages to your site, you can either write a markdown file (.md) or you can write an HTML file directly. It is much easier to write markdown than HTML, so I suggest you do that (use the [tutorial I mentioned above](https://markdowntutorial.com/) if you need to learn markdown). You can look at some files on this site to get an idea of how to write markdown. To look at existing files, click on any file that ends in .md, for example [aboutme.md](./aboutme.md). On the next page you can see some nicely formatted text (there is a word in bold, a link, bullet points), and if you click on the pencil icon to edit the file, you will see the markdown that generated the pretty text. Very easy!  68 69 70  In contrast, look at [index.html](./index.html). That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML.  Dean Attali committed Mar 27, 2016 71 Any file that you add inside the [_posts](./_posts) directory will be treated as a blog entry. You can look at the existing files there to get an idea of how to write blog posts. After you successfully add your own post, you can delete the existing files inside [_posts](./_posts) to remove the sample posts, as those are just demo posts to help you learn.  Dean Attali committed Mar 02, 2015 72   Dean Attali committed Oct 11, 2018 73 As mentioned previously, you can use [prose.io](https://prose.io/) to add or edit files instead of doing it directly on GitHub, it can be a little easier that way.  Dean Attali committed Jun 20, 2015 74   Dean Attali committed Oct 10, 2016 75 ## Last important thing: YAML front matter ("parameters" for a page)  Dean Attali committed Mar 02, 2015 76   Dean Attali committed Oct 11, 2018 77 In order to have your new pages use this template and not just be plain pages, you need to add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page. This is where you'll give each page some parameters that I made available, such as a title and subtitle. I'll go into more detail about what parameters are available later. If you don't want to use any parameters on your new page (this also means having no title), then use the empty YAML front matter:  Dean Attali committed Mar 02, 2015 78 79 80 81 82 83   --- ---   Dean Attali committed Mar 10, 2015 84 If you want to use any parameters, write them between the two lines. For example, you can have this at the top of a page:  Dean Attali committed Mar 02, 2015 85   Dean Attali committed Mar 10, 2015 86 87 88 89 90 91 92  --- title: Contact me subtitle: Here you'll find all the ways to get in touch with me ---   Dean Attali committed Mar 10, 2015 93 You can look at the top of [aboutme.md](./aboutme.md) or [index.html](./index.html) as more examples.  Dean Attali committed Mar 10, 2015 94   Dean Attali committed Oct 10, 2016 95 **Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines.**      96 If you don't include YAML then your file will not use the template.  Dean Attali committed Mar 03, 2015 97   Dean Attali committed Oct 10, 2016 98 ## Features  Dean Attali committed Mar 02, 2015 99   Dean Attali committed Oct 10, 2016 100 ### Mobile-first  Dean Attali committed Mar 27, 2016 101 **Beautiful Jekyll** is designed to look great on both large-screen and small-screen (mobile) devices. Load up your site on your phone or your gigantic iMac, and the site will work well on both, though it will look slightly different.  Dean Attali committed Mar 02, 2015 102   Dean Attali committed Oct 10, 2016 103 ### Customizable  Dean Attali committed Mar 02, 2015 104   Dean Attali committed Sep 04, 2017 105 Many personalization settings in _config.yml, such as setting your name and site's description, changing the background colour/image, setting your avatar to add a little image in the navigation bar, customizing the links in the menus, customizing what social media links to show in the footer, etc.  Dean Attali committed Mar 13, 2015 106   Dean Attali committed Oct 10, 2016 107 ### Allowing users to leave comments  Dean Attali committed Mar 13, 2015 108   Oleksii Rudenko committed May 14, 2019 109 If you want to enable comments on your site, Beautiful Jekyll supports either the [Disqus](https://disqus.com/) comments plugin, [Facebook](https://developers.facebook.com/docs/plugins/comments) comments, [Staticman](https://staticman.net) or [JustComments](https://just-comments.com). If any of these are set in the configuration file, then all blog posts will have comments turned on by default. To turn off comments on a particular blog post, add comments: false to the YAML front matter. If you want to add comments on the bottom of a non-blog page, add comments: true to the YAML front matter.  Dean Attali committed Mar 13, 2015 110   Dean Attali committed Dec 20, 2018 111 #### Disqus comments  npes87184 committed Jun 08, 2018 112   Dean Attali committed Dec 20, 2018 113 To use Disqus, simply sign up to [Disqus](https://disqus.com/) and add your Disqus shortname to the disqus parameter in the _config.yml file.  npes87184 committed Jun 08, 2018 114   Dean Attali committed Dec 20, 2018 115 #### Facebook comments  Vincent Tam committed Dec 20, 2018 116   Dean Attali committed Dec 20, 2018 117 To use Facebook comments, create a Facebook app using [Facebook developers](https://developers.facebook.com/docs/apps/register), and add the Facebook App ID to the fb_comment_id parameter in _config.yml.  Vincent Tam committed Dec 20, 2018 118   Dean Attali committed Dec 20, 2018 119 #### Staticman comments  Vincent Tam committed Dec 20, 2018 120   Vincent Tam committed Jul 08, 2019 121 To use Staticman, you first need to invite staticmanlab as a collaborator to your repository (by going to your repository **Settings** page, navigate to the **Collaborators** tab, and add the username staticmanlab), and then accept the invitation by going to https://staticman3.herokuapp.com/v3/connect/github//. Lastly, fill in the staticman parameters in the Staticman section of _config.yml. You may also choose a different Staticman instance other than staticmanlab.  Dean Attali committed Mar 13, 2015 122   Vincent Tam committed Dec 21, 2018 123 124 ![Staicman invitation screenshot](https://user-images.githubusercontent.com/5748535/50357920-e8f25500-0557-11e9-9cb6-73f8b575c4f0.png)  Vincent Tam committed Jul 08, 2019 125 Optional: You may want to configure a webhook to prevent old inactive branches (representing approved comments) from stacking up. You can refer to [Staticman's documenation](https://staticman.net/docs/webhooks) for details. Make sure to input the **Payload URL** according to your chosen endpoint. For example, the default endpoint is https://staticman3.herokuapp.com/v3/entry/github/, so the corresponding **Payload URL** should be https://staticman3.herokuapp.com/v1/webhook.  Vincent Tam committed Jun 25, 2019 126   Oleksii Rudenko committed May 14, 2019 127 #### JustComments  Hugo Alves committed Mar 25, 2019 128   Oleksii Rudenko committed May 14, 2019 129 To use JustComments you first need to have an account. After you just need to copy the API key to the just-comments property in _config.yml file.  Hugo Alves committed Mar 25, 2019 130   Dean Attali committed Oct 10, 2016 131 ### Adding Google Analytics to track page views  Dean Attali committed Mar 13, 2015 132   Dean Attali committed Oct 11, 2018 133 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](https://www.google.com/analytics/) to obtain your Google Tracking ID, and add this tracking ID to the google_analytics parameter in _config.yml.  Dean Attali committed Aug 06, 2016 134   Dean Attali committed Oct 10, 2016 135 ### Sharing blog posts on social media  Dean Attali committed Aug 06, 2016 136   Dean Attali committed Aug 06, 2016 137 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.  Dean Attali committed Mar 02, 2015 138   Dean Attali committed Oct 10, 2016 139 140 141 142 143 ### RSS feed Beautiful Jekyll automatically generates a simple RSS feed of your blog posts, to allow others to subscribe to your posts. If you want to add a link to your RSS feed in the footer of every page, find the rss: false line in _config.yml and change it to rss: true. ### Page types  Dean Attali committed Mar 02, 2015 144   Dean Attali committed Mar 27, 2016 145 146 147 148 - **post** - To write a blog post, add a markdown or HTML file in the _posts folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts. - **page** - Any page outside the _posts folder that uses YAML front matter will have a very similar style to blog posts. - **minimal** - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign layout: minimal to the YAML front matter. - If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML!  Dean Attali committed Mar 02, 2015 149   Dean Attali committed Oct 10, 2016 150 ### YAML front matter parameters  Dean Attali committed Mar 02, 2015 151   Dean Attali committed Mar 13, 2015 152 These are the main parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports.  Dean Attali committed Mar 03, 2015 153   Dean Attali committed Mar 03, 2015 154 155 156 Parameter | Description ----------- | ----------- title | Page or blog post title  Dean Attali committed Mar 27, 2016 157 subtitle | Short description of page or blog post that goes under the title  Dean Attali committed Jan 19, 2018 158 tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: [personal, self help, finance]  Dean Attali committed Oct 11, 2018 159 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](https://deanattali.com/) as an example).  Hugo Alves committed Mar 25, 2019 160 comments | If you want do add 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 enable at least one provider(diqus, staticman, just-comments) in _config.yml file.  Dean Attali committed Mar 18, 2016 161 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.  Dean Attali committed Dec 24, 2016 162 image | If you want to add a personalized image to your blog post that will show up next to the post's excerpt and on the post itself, use image: /path/to/img.  Dean Attali committed Jul 20, 2016 163 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.  Dean Attali committed Aug 06, 2016 164 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).  Dean Attali committed Jan 06, 2017 165 use-site-title | If you want to use the site title rather than page title as HTML document title (ie. browser tab title), use use-site-title: true. When set, the document title will take the format Site Title - Site Description (eg. My website - A virtual proof that name is awesome!). By default, it will use Page Title if it exists, or Site Title otherwise.  npes87184 committed Apr 21, 2018 166 layout | What type of page this is (default is post for blog posts and page for other pages. You can use minimal if you don't want a header and footer)  Dean Attali committed Mar 03, 2015 167 js | List of local JavaScript files to include in the page (eg. /js/mypage.js)  Tony Ho committed Jan 27, 2017 168 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). External JavaScript files that support [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) can be specified using the href and sri parameters eg.
href: "//code.jquery.com/jquery-3.1.1.min.js"
sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="  Dean Attali committed Mar 03, 2015 169 css | List of local CSS files to include in the page  Marco Blessing committed Jan 18, 2018 170 ext-css | List of external CSS files to include in the page. External CSS files using SRI (see ext-js parameter) are also supported.  Dean Attali committed Mar 03, 2015 171 googlefonts | List of Google fonts to include in the page (eg. ["Monoton", "Lobster"])  yonicd committed Oct 16, 2017 172 173 gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. daattali/beautiful-jekyll). You must also use the gh-badge parameter to specify what buttons to show. gh-badge | Select which GitHub buttons to display, available options are: [star, watch, fork, follow]. You must also use the gh-repo parameter to specify the GitHub repo.  Dean Attali committed Mar 02, 2015 174   Dean Attali committed Oct 10, 2016 175 ### Advanced features (including how to use a custom URL address for your site)  Dean Attali committed Mar 02, 2015 176   Dean Attali committed Oct 11, 2018 177 I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that are applicable to any Jekyll site. It describes how I used a custom URL for my site (deanattali.com instead of daattali.github.io), how to add a Google-powered search into your site, and provides a few more details about having an RSS feed.  Dean Attali committed Mar 02, 2015 178   Dean Attali committed Oct 10, 2016 179 ## Creating a User Page vs a Project Page  Dean Attali committed Mar 02, 2015 180   Dean Attali committed Oct 10, 2016 181 If you're not sure what the difference is, you can probably safely ignore this section.  Dean Attali committed Mar 13, 2015 182   Dean Attali committed Oct 10, 2016 183 If you want to use this theme to host a website that will be available at https://YOURUSERNAME.github.io, then you do not need to read this section. That is called a User Page, you can only have one User Page in your GitHub account, and it is what you get by default when forking this project.  Dean Attali committed Mar 15, 2015 184   Dean Attali committed Jun 22, 2019 185 If you want to use this theme to create a website for a particular repository, it will be available at https://YOURUSERNAME.github.io/PROJECTNAME, and that is called a [Project Page](https://help.github.com/articles/user-organization-and-project-pages/). You can have a Project Page for any repository you have on GitHub.  Dean Attali committed Oct 10, 2016 186   Vincent Tam committed Jun 28, 2019 187 **When using this theme for a Project Page, by default your website will be served from the gh-pages branch**, so you must take the following steps:  Abel Cheung committed Jun 21, 2019 188   Dean Attali committed Jun 22, 2019 189 1. [Delete the existing gh-pages branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)  Dean Attali committed Oct 10, 2016 190   Dean Attali committed Jun 22, 2019 191 192 2. [Create a new branch named gh-pages from the master branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository#creating-a-branch)  Vincent Tam committed Jun 28, 2019 193 Alternatively, instead of the above two steps, you can opt to use the master branch instead of gh-pages branch as your website's source by choosing that option in the main Settings page.  Dean Attali committed Mar 15, 2015 194   Dean Attali committed Oct 10, 2016 195 ## Showcased users (success stories!)  Dean Attali committed Sep 05, 2015 196   Dean Attali committed Jul 25, 2016 197 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.  Dean Attali committed Sep 05, 2015 198   Dean Attali committed Oct 11, 2018 199 Want your website featured here? [Contact me](https://deanattali.com/aboutme#contact) to let me know about your website.  Dean Attali committed Sep 05, 2015 200   Dean Attali committed Oct 10, 2016 201 ### Project/company websites  Dean Attali committed Sep 05, 2015 202 203 204  | Website | Description | | :------ |:----------- |  Dean Attali committed Oct 11, 2018 205 | [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium |  Dean Attali committed Mar 26, 2018 206 | [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium |  Dean Attali committed Sep 14, 2015 207 | [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses |  Dean Attali committed Sep 05, 2015 208 | [bigdata.juju.solutions](http://bigdata.juju.solutions) | Creating Big Data solutions Juju Solutions |  Dean Attali committed Sep 20, 2015 209 | [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app |  Dean Attali committed Jan 04, 2017 210 | [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package |  Dean Attali committed Sep 05, 2015 211 | [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs |  Dean Attali committed Apr 25, 2016 212 | [reactionic.github.io](http://reactionic.github.io) | Create iOS and Android apps with React and Ionic |  Dean Attali committed Jul 25, 2016 213 | [ja2-stracciatella.github.io](http://ja2-stracciatella.github.io) | Jagged Alliance 2 Stracciatella |  Dean Attali committed Mar 08, 2017 214 | [ddocent.com](http://ddocent.com/) | RADSeq Bioinformatics and Beyond |  Dean Attali committed May 04, 2018 215 | [guitarlessons.org](https://www.guitarlessons.org/) | Free online guitar lessons for all |  Dean Attali committed Jun 13, 2018 216 217 | [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake |  Dean Attali committed Sep 05, 2015 218   Dean Attali committed Oct 10, 2016 219 ### Personal websites  Dean Attali committed Sep 05, 2015 220 221 222  | Website | Who | What | | :------ |:--- | :--- |  Dean Attali committed Oct 11, 2018 223 | [deanattali.com](https://deanattali.com) | Dean Attali | Creator of Beautiful Jekyll |  Dean Attali committed Sep 05, 2015 224 | [ouzor.github.io](http://ouzor.github.io) | Juuso Parkkinen | Data scientist |  Dean Attali committed Sep 14, 2015 225 | [derekogle.com](http://derekogle.com/) | Derek Ogle | Professor of Mathematical Sciences and Natural Resources |  Dean Attali committed Feb 11, 2016 226 | [melyanna.github.io](http://melyanna.github.io/) | Melyanna | Shows off her nice art |  Dean Attali committed Apr 22, 2016 227 | [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology |  Dean Attali committed Apr 25, 2016 228 | [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics |  Dean Attali committed Jul 08, 2016 229 | [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics |  Dean Attali committed Oct 11, 2016 230 | [anudit.in](http://www.anudit.in/) | Anudit Verma | Engineering student |  Oscar Medina committed Mar 14, 2017 231 | [sharepointoscar.github.io](http://sharepointoscar.github.io) | Oscar Medina | Independent Hacker |  Marco Blessing committed May 29, 2018 232 | [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation |  Dean Attali committed Jul 06, 2018 233 | [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software |  Dean Attali committed Sep 05, 2015 234   Dean Attali committed Oct 10, 2016 235 ## Advanced: Local development using Docker  Dean Attali committed Mar 27, 2016 236   Dean Attali committed Jan 15, 2018 237 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 set that up with Docker:  Marcio Mangar committed Oct 08, 2016 238   Marco Blessing committed Jan 18, 2018 239 1. Make sure you have [Docker](https://www.docker.com/) installed.  Jennings Zhang committed Jan 15, 2018 240   Dean Attali committed Jan 15, 2018 241 2. Clone your repository locally.  Jennings Zhang committed Jan 15, 2018 242   Dean Attali committed Jan 15, 2018 243 244 245  bash git clone https://github.com//.github.io.git   Jennings Zhang committed Jan 15, 2018 246   Dean Attali committed Jan 15, 2018 247 3. Run the following shell commands to build the docker image and start the container for the first time:  Jennings Zhang committed Jan 15, 2018 248   Dean Attali committed Jan 15, 2018 249 250  bash cd  Chris Kennedy committed Apr 25, 2018 251 252  docker build -t beautiful-jekyll "$PWD" docker run -d -p 4000:4000 --name beautiful-jekyll -v "$PWD":/srv/jekyll beautiful-jekyll  Dean Attali committed Jan 15, 2018 253    Jennings Zhang committed Jan 15, 2018 254 255   Dean Attali committed Jan 15, 2018 256 Now that Docker is set up, you do not need to run the above steps again. You can now view your website at http://localhost:4000/. You can start the container again in the future with:  Jennings Zhang committed Jan 15, 2018 257 258 259 260 261  bash docker start beautiful-jekyll   Dean Attali committed Jan 15, 2018 262 And you can stop the server with:  Jennings Zhang committed Jan 15, 2018 263 264  bash  Dean Attali committed Jan 15, 2018 265 docker stop beautiful-jekyll  Jennings Zhang committed Jan 15, 2018 266   Dean Attali committed Oct 08, 2016 267   Dean Attali committed Jan 15, 2018 268 Whenever you make any changes to _config.yml, you must stop and re-start the server for the new config settings to take effect.  Dean Attali committed Jan 15, 2018 269   Jennings Zhang committed Jan 15, 2018 270 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!  Marcio Mangar committed Oct 08, 2016 271   Dean Attali committed Apr 01, 2018 272 ## FAQ and support  Dean Attali committed Oct 16, 2017 273   Dean Attali committed Apr 01, 2018 274 275 If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/).  Dean Attali committed Oct 11, 2018 276 Beautiful Jekyll is actively used by thousands of people with wildly varying degrees of competency, so it's impossible to answer all the questions that may arise. Below are answers to a few very common questions. Most questions that I get asked are not directly related to this theme, and instead are more general questions about Jekyll or web development. Many such questions can be answered by reading the [Jekyll documentation](https://jekyllrb.com/) or with Google.  Dean Attali committed Oct 16, 2017 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292  #### How do I change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...? Beautiful Jekyll is built to be very customizable, and as such, many questions about "how do I change ..." can be answered by looking at the _config.yml file. The configuration file has many adjustable parameters to customize your site. #### How do I add a favicon to my site? Easy! Just place a valid favicon.ico (or another valid favicon image) in the root directory of your project. And then wait! It can take a while to update. #### How do I move the blog to another page instead of having it on the home page? The default style of Beautiful Jekyll is to feature the blog feed on the front page. But for many sites that's not the ideal structure, and you may want to have a separate dedicated page for the blog posts. To have the blog hosted on a different URL (for example at /blog), copy the index.html file into a folder with the same name as the desired page (for example, to blog/index.html), and in the _config.yml file you need to add a parameter paginate_path: "//page:num/" (for example paginate_path: "/blog/page:num/"). #### What size do you recommend using for the bigimg photos? Unfortunately, this is a no-answer! There isn't a one-size-fits-all solution to this, because every person will view your site on a different browser with different dimensions. Some browsers will have very wide aspect ratio, some will be narrower, some will be vertical (such as phones), different phones have different screens, etc. The image will always be centered, so the only tip I can give is that you should make sure the important part of the image is in the middle so that it'll always show. Other than that, every browser will show a different clipping of the image.  Dean Attali committed Jul 27, 2016 293   Dean Attali committed Jul 02, 2019 294 295 296 297 #### How do I use MathJax equations in my posts? MathJax can be easily integrated into your website with a one-line addition. You can see [this discussion](https://github.com/daattali/beautiful-jekyll/issues/195) for more information.  Dean Attali committed Jun 22, 2019 298 #### My project page appear to be broken after a recent update!  Abel Cheung committed Jun 21, 2019 299   Dean Attali committed Jun 22, 2019 300 In June 2019, some URL related settings have been adjusted to be more in-line with how Jekyll uses them officially. Project Page absolute links might appear to be broken if you haven't propagated all necessary changes to your local templates, or if you have created additional templates making use of old settings. If a link contains a duplicated project path component, this is most likely the cause. In summary:  Abel Cheung committed Jun 21, 2019 301 302 303  |   | Old behavior | New behavior | | --- | --- | --- |  Dean Attali committed Jun 22, 2019 304 305 | url setting | https://user.github.io/projectname | (unset, GitHub auto detects) | | baseurl setting | /projectname | (unset, GitHub auto detects) |  Abel Cheung committed Jun 21, 2019 306 307 308 | Absolute link construction | {{ site.url }}/your/path | {{ '/your/path' \| absolute_url }} | | Relative link construction | {{ site.baseurl }}/your/path | {{ '/your/path' \| relative_url }} |  Dean Attali committed Oct 10, 2016 309 ## Credits  Dean Attali committed Sep 05, 2015 310 311 312 313 314  This template was not made entirely from scratch. I would like to give special thanks to: - [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. - [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.  Dean Attali committed Oct 11, 2018 315 I'd also like to thank [Dr. Jekyll's Themes](https://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.  Dean Attali committed Sep 05, 2015 316   Dean Attali committed Oct 10, 2016 317 ## Contributions  Dean Attali committed Sep 05, 2015 318 319 320  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!  Dean Attali committed Jun 22, 2019 321 Thank you to [all contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). Special thanks to [@OCram85](https://github.com/OCram85) and [@abelcheung](https://github.com/abelcheung) for contributing multiple times as well as helping with discussions.  Dean Attali committed Aug 06, 2016 322 323  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 :)  Dean Attali committed Sep 05, 2015 324   Dean Attali committed Oct 10, 2016 325 ## Known limitations  Dean Attali committed Mar 02, 2015 326 327  - If you have a project page and you want a custom 404 page, you must have a custom domain. See https://help.github.com/articles/custom-404-pages/. This means that if you have a regular User Page you can use the 404 page from this theme, but if it's a website for a specific repository, the 404 page will not be used.  Dean Attali committed Jun 22, 2019 328   Vincent Tam committed Jun 28, 2019 329 - If there are many navigation bar links and and avatar, some of the links may get partially hidden behind the avatar.