From feb2f502e3ac74033559d7cb71be8f21d9824617 Mon Sep 17 00:00:00 2001 From: amitmerchant1990 Date: Tue, 25 Jun 2019 00:16:05 +0530 Subject: [PATCH] Updated readme --- README.md | 12 +++++++----- .../2019-02-13-introducing-reverie-jekyll-theme.md | 10 +++++++--- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index baabe1b..6f4e031 100644 --- a/README.md +++ b/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) -## Features +## Features overview - 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 - Free hosting on your GitHub Pages user site - 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 - Disqus commenting - Google Analytics integration +- Fuzzy search across blog posts - Categorize posts out-of-the box - A home widget to show recent GitHub commit - RSS Feed +- In-built sitemap ## Using Reverie on GitHub Pages ### 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 (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 -The generated sitemap of your blog can be found at . +The generated sitemap of your blog can be found at . You can see the example sitemap feed over [here](https://www.amitmerchant.com/sitemap). ## The name? diff --git a/_posts/2019-02-13-introducing-reverie-jekyll-theme.md b/_posts/2019-02-13-introducing-reverie-jekyll-theme.md index 1358559..ef494db 100644 --- a/_posts/2019-02-13-introducing-reverie-jekyll-theme.md +++ b/_posts/2019-02-13-introducing-reverie-jekyll-theme.md @@ -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) -## Features +## Features overview - 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) @@ -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 - Disqus commenting - Google Analytics integration +- Fuzzy search across blog posts - Categorize posts out-of-the box - A home widget to show recent GitHub commit - RSS Feed +- In-built sitemap ## Using Reverie on GitHub Pages ### 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 (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 -The generated sitemap of your blog can be found at . +The generated sitemap of your blog can be found at . You can see the example sitemap feed over [here](https://www.amitmerchant.com/sitemap). ## License