- Add `text-col `config setting for main text color (#694)
- Add `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691)
- Add `mobile-theme-col` config setting to allow a mobile theme colour (#692)
- Add `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695)
- Add YAML option `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690)
## v4.0.1 2020-07-13
- Fixed staticman comments UI that was broken since the migration to bootstrap 4
@ -130,3 +139,4 @@
... Many small changes because the site was in its infancy
**2015-03-12** Beautiful Jekyll version 0.0000001 is released!
> *Created by [Dean Attali](https://deanattali.com)* · [Demo](https://beautifuljekyll.com/)
**Beautiful Jekyll** is a ready-to-use template to help you create a beautiful website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) 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 [below](#showcased-users-success-stories).
**If you enjoy this theme, please consider [sponsoring me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
**If you enjoy this theme, please consider [supporting me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
@ -122,7 +123,7 @@ If you don't include YAML then your file will not use this template.
Below is a list of the parameters that **Beautiful Jekyll** supports (any of these can be added to the YAML front matter of any page). Remember to also look in the `_config.yml` file to see additional settings.
## Main paramaters
## Main parameters
These are the basic YAML parameters that you are most likely to use on most pages.
@ -149,6 +150,7 @@ nav-short | By default, the navigation bar gets shorter after scrolling down t
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.
layout | What type of page this is (default is `post` for blog posts and `page` for other pages). See _Page types_ section below for more information.
description | A brief description of the page (used in search engines and when the page is shared).
## Advanced parameters
@ -174,7 +176,7 @@ ext-css | List of external CSS files to include in the page. External CSS f
# Showcased users (success stories!)
Beautiful Jekyll has been used in over 500 websites in its first 6 months, and tens of thousands of times since its inception. Here is a sample of some websites that use Beautiful Jekyll.
Beautiful Jekyll has been used in tens of thousands of websites since 2015. Here is a sample of some websites that use Beautiful Jekyll. If you'd like to showcase yourself and join this list, any level of [sponsorship](https://github.com/sponsors/daattali) will grant you that perk!
## Project/company websites
@ -217,33 +219,37 @@ Beautiful Jekyll is actively used by thousands of people with wildly varying deg
**If you really wany my personal help, please visit https://xscode.com/daattali/beautiful-jekyll to hire my services.**
### What if I don't want the website to be `https://<yourusername>.github.io`?
- ### How do I add a favicon to my site?
Every GitHub user can have one repository (repository = project) named `<yourusername>.github.io` and the website for that repository will be `https://<yourusername>.github.io`.
Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
If you want your project to be named something else, for example `MyAwesomeProject`, that's no problem! All you have to do is go to _Settings_ at the top right corner of the page, and rename your repository to `MyAwesomeProject` (**remember to click on the _Rename_ button to confirm!**). Then you need to scroll down to the _GitHub Pages_ section and choose "master branch" as the source (not "master branch /docs folder"!).
- ### 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 ...?
Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
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 change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...?
- ### What if I want to use a custom domain for my site?
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.
GitHub lets you have your website for free using their `github.io` domain. If you want your own domain (such as `https://myname.com`), it's easy and will cost about $10-$15 per year. First you need to buy a domain name (I recommend [Namecheap](https://namecheap.pxf.io/daattali)) and then follow the [instructions GitHub provides](https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site).
### How do I add a favicon to my site?
- ### What if I want a free domain, but not `https://<yourusername>.github.io`?
Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
Every GitHub user can have one repository (repository = project) named `<yourusername>.github.io` and the website for that repository will be `https://<yourusername>.github.io`.
### How do I move the blog to another page instead of having it on the home page?
If you want your project to be named something else, for example `MyAwesomeProject`, that's no problem! All you have to do is go to _Settings_ at the top right corner of the page, and rename your repository to `MyAwesomeProject` (**remember to click on the _Rename_ button to confirm!**). Then you need to scroll down to the _GitHub Pages_ section and choose "master branch" as the source (not "master branch /docs folder"!).
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 `<mysite.com>/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 name>/page:num/"` (for example `paginate_path: "/blog/page:num/"`).
Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
### What size do you recommend using for the `cover-img` photos?
- ### How do I move the blog to another page instead of having it on the home page?
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.
The default style of Beautiful Jekyll is to feature the blog feed on the front page. For some 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 `<mysite.com>/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 name>/page:num/"` (for example `paginate_path: "/blog/page:num/"`).
### How do I use MathJax equations in my posts?
- ### What size do you recommend using for the `cover-img` photos?
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.
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.
- ### How do I use math 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.
# Contributions
@ -260,3 +266,4 @@ I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/),
# Known limitations
- If there are many navigation bar links and an avatar, some of the links may get partially hidden behind the avatar. I suggest either re-thinking the number of links, or not using an avatar.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
