Updated readme
This commit is contained in:
parent
ca10b5ec5a
commit
feb2f502e3
12
README.md
12
README.md
|
@ -12,10 +12,10 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
|
||||||
|
|
||||||
![](/images/reverie-demo.png)
|
![](/images/reverie-demo.png)
|
||||||
|
|
||||||
## Features
|
## Features overview
|
||||||
|
|
||||||
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
|
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
|
||||||
- Fully responsive and mobile optimized base theme (Theme Demo)
|
- Fully responsive and mobile optimized base theme
|
||||||
- Sass/Coffeescript support using Jekyll 2.0
|
- Sass/Coffeescript support using Jekyll 2.0
|
||||||
- Free hosting on your GitHub Pages user site
|
- Free hosting on your GitHub Pages user site
|
||||||
- Markdown blogging
|
- Markdown blogging
|
||||||
|
@ -25,17 +25,19 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
|
||||||
- [Dracula syntax theme](https://draculatheme.com/) included
|
- [Dracula syntax theme](https://draculatheme.com/) included
|
||||||
- Disqus commenting
|
- Disqus commenting
|
||||||
- Google Analytics integration
|
- Google Analytics integration
|
||||||
|
- Fuzzy search across blog posts
|
||||||
- Categorize posts out-of-the box
|
- Categorize posts out-of-the box
|
||||||
- A home widget to show recent GitHub commit
|
- A home widget to show recent GitHub commit
|
||||||
- RSS Feed
|
- RSS Feed
|
||||||
|
- In-built sitemap
|
||||||
|
|
||||||
## Using Reverie on GitHub Pages
|
## Using Reverie on GitHub Pages
|
||||||
|
|
||||||
### Step 1) Fork Reverie to your User Repository
|
### Step 1) Fork Reverie to your User Repository
|
||||||
|
|
||||||
Fork this repo, then rename the repository to `yourgithubusername.github.io`.
|
Fork this repository, then rename the repository to `yourgithubusername.github.io`.
|
||||||
|
|
||||||
Alternatively, you can use [`Use this template`](https://github.com/amitmerchant1990/reverie/generate) button if you want to create a repo with clean commit history which will use Reverie as a template.
|
Alternatively, you can use [`Use this template`](https://github.com/amitmerchant1990/reverie/generate) button if you want to create a repository with a clean commit history which will use Reverie as a template.
|
||||||
|
|
||||||
Your Jekyll blog will often be viewable immediately at <https://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2)
|
Your Jekyll blog will often be viewable immediately at <https://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2)
|
||||||
|
|
||||||
|
@ -75,7 +77,7 @@ The generated [RSS feed](https://en.wikipedia.org/wiki/RSS) of your blog can be
|
||||||
|
|
||||||
## Sitemap
|
## Sitemap
|
||||||
|
|
||||||
The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>.
|
The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>. You can see the example sitemap feed over [here](https://www.amitmerchant.com/sitemap).
|
||||||
|
|
||||||
## The name?
|
## The name?
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ This is a plug-and-play Jekyll theme which you can use on GitHub Pages without e
|
||||||
|
|
||||||
![](/images/reverie-demo.png)
|
![](/images/reverie-demo.png)
|
||||||
|
|
||||||
## Features
|
## Features overview
|
||||||
|
|
||||||
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
|
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
|
||||||
- Fully responsive and mobile optimized base theme (Theme Demo)
|
- Fully responsive and mobile optimized base theme (Theme Demo)
|
||||||
|
@ -23,15 +23,19 @@ This is a plug-and-play Jekyll theme which you can use on GitHub Pages without e
|
||||||
- [Dracula syntax theme](https://draculatheme.com/) included
|
- [Dracula syntax theme](https://draculatheme.com/) included
|
||||||
- Disqus commenting
|
- Disqus commenting
|
||||||
- Google Analytics integration
|
- Google Analytics integration
|
||||||
|
- Fuzzy search across blog posts
|
||||||
- Categorize posts out-of-the box
|
- Categorize posts out-of-the box
|
||||||
- A home widget to show recent GitHub commit
|
- A home widget to show recent GitHub commit
|
||||||
- RSS Feed
|
- RSS Feed
|
||||||
|
- In-built sitemap
|
||||||
|
|
||||||
## Using Reverie on GitHub Pages
|
## Using Reverie on GitHub Pages
|
||||||
|
|
||||||
### Step 1) Fork Reverie to your User Repository
|
### Step 1) Fork Reverie to your User Repository
|
||||||
|
|
||||||
Fork [this repo](https://github.com/amitmerchant1990/reverie), then rename the repository to `yourgithubusername.github.io`.
|
Fork [this repository](https://github.com/amitmerchant1990/reverie), then rename the repository to `yourgithubusername.github.io`.
|
||||||
|
|
||||||
|
Alternatively, you can use [Use this template](https://github.com/amitmerchant1990/reverie/generate) button if you want to create a repository with a clean commit history which will use Reverie as a template.
|
||||||
|
|
||||||
Your Jekyll blog will often be viewable immediately at <https://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2)
|
Your Jekyll blog will often be viewable immediately at <https://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2)
|
||||||
|
|
||||||
|
@ -71,7 +75,7 @@ The generated [RSS feed](https://en.wikipedia.org/wiki/RSS) of your blog can be
|
||||||
|
|
||||||
## Sitemap
|
## Sitemap
|
||||||
|
|
||||||
The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>.
|
The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>. You can see the example sitemap feed over [here](https://www.amitmerchant.com/sitemap).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue