add note about sometimes having to re-trigger build; fixes #710
This commit is contained in:
Dean Attali
parent
5991966d38
commit
8438f3dbe2
32
README.md
32
README.md
|
|
@ -9,19 +9,28 @@
|
|||
|
||||
**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!)**
|
||||
|
||||
<p align="center">
|
||||
<a style="display: inline-block;" href="https://github.com/sponsors/daattali">
|
||||
<img height="40" src="https://i.imgur.com/034B8vq.png" />
|
||||
</a>
|
||||
|
||||
<a style="display: inline-block;" href="https://paypal.me/daattali">
|
||||
<img height="40" src="https://camo.githubusercontent.com/0e9e5cac101f7093336b4589c380ab5dcfdcbab0/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f74776f6c66736f6e2f70617970616c2d6769746875622d627574746f6e40312e302e302f646973742f627574746f6e2e737667" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## 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
|
||||
|
|
@ -41,12 +50,6 @@ 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.
|
||||
|
||||
<h2 id="sponsors">Sponsors 🏆</h2>
|
||||
|
||||
> 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.
|
||||
|
|
@ -65,7 +68,7 @@ Fork this project by clicking the __*Fork*__ button at the top right corner of t
|
|||
|
||||
### 2. Rename the project to `<yourusername>.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://<yourusername>.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name.
|
||||
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://<yourusername>.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
|
||||
|
||||
|
|
@ -81,9 +84,6 @@ 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
|
||||
|
||||
|
|
@ -268,6 +268,12 @@ 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.
|
||||
|
||||
<h2 id="sponsors">Sponsors 🏆</h2>
|
||||
|
||||
> There are no sponsors yet
|
||||
|
||||
[Become the first sponsor for Beautiful Jekyll\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)
|
||||
|
||||
# Contributions
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue