diff --git a/README.md b/README.md index ef68850..2fd7340 100644 --- a/README.md +++ b/README.md @@ -9,28 +9,19 @@ **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 Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali) for over 5 years of development (and to unlock rewards!)** - -

- - - -    - - - -

+**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali) for over 5 years of development (and to unlock rewards!) ❤** ## Table of contents - [Features](#features) +- [Sponsors 🏆](#sponsors) - [**Build your website in 3 steps**](#build-your-website-in-3-steps) +- [Plans](#plans) - [Add your own content](#add-your-own-content) - [Customizing parameters for each page](#customizing-parameters-for-each-page) - [Supported parameters](#supported-parameters) - [Showcased users (success stories!)](#showcased-users-success-stories) - [FAQ and support](#faq-and-support) -- [Sponsors 🏆](#sponsors) - [Credits and contributions](#credits) # Features @@ -50,6 +41,12 @@ Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the lates - **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image. - **RSS**: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll. +

Sponsors 🏆

+ +> There are no sponsors yet + +[Become the first sponsor for Beautiful Jekyll and unlock special rewards\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856) + # Build your website in 3 steps There's a very easy way to use this theme, and there's a hard way. For most people (including myself!), I suggest going the easy route. If you're an advanced user and want to tinker with the hard way (using ruby gems), then [skip the easy way](https://github.com/daattali/beautiful-jekyll#the-hard-way-using-ruby-gems) if you know what you're doing. @@ -68,7 +65,7 @@ Fork this project by clicking the __*Fork*__ button at the top right corner of t ### 2. Rename the project to `.github.io` -Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*Repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name. If after a few minutes your website is not ready, try making any edit to any file, just to force GitHub to re-build your site. +Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name. If after a few minutes your website is not ready, try making any edit to any file, just to force GitHub to re-build your site. ### 3. Customize your website settings @@ -84,6 +81,9 @@ Note that in the video above I only edited one setting in the `_config.yml` file If you followed the easy method above, then you already have your site and you can skip this section! If you want to install beautiful-jekyll using ruby gems instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard). +# Plans + +Beautiful Jekyll is, and always will be, free. But if you want to remove the Beautiful Jekyll ad from your website, use a Dark Mode skin, or unlock other special rewards, [check out the different plans](https://beautifuljekyll.com/plans). # Add your own content @@ -159,7 +159,7 @@ readtime | If you want a post to show how many minutes it will take to read i 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`. social-share | By default, every blog post has buttons to share the page on social media. If you want to turn this feature off, use `social-share: false`. nav-short | By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use `nav-short: true` -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-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. @@ -268,12 +268,6 @@ Beautiful Jekyll is actively used by thousands of people with wildly varying deg - ### 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. - -

Sponsors 🏆

- -> There are no sponsors yet - -[Become the first sponsor for Beautiful Jekyll\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856) # Contributions @@ -285,4 +279,4 @@ You can also contribute by becoming an [official sponsor](https://github.com/spo This template was not made *entirely* from scratch. I'd like to give special thanks to [Jekyll Now](https://github.com/barryclark/jekyll-now) and [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from whom I've taken several ideas initially. -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. +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. \ No newline at end of file