Merge branch 'master' of github.com:amitmerchant1990/reverie

README.md

@@ -1,7 +1,17 @@
-Reverie is a Jekyll theme which is simple and opinionated. It's actually a fork of [jekyll-now](https://github.com/barryclark/jekyll-now) with some additional features and personal touches which I've implemented to suit my needs for [my blog](https://www.amitmerchant.com).
+<h1 align="center">
+  <br>
+  <img src="/images/reverie-text.png" alt="Markdownify" width="200">
+  <br>
+</h1>
+
+Reverie is a [Jekyll](https://jekyllrb.com/)-powered theme which is simple and opinionated. It's actually a fork of [jekyll-now](https://github.com/barryclark/jekyll-now) with some additional features and [personal touches](https://github.com/amitmerchant1990/amitmerchant1990.github.io) which I've implemented to suit my needs for [my blog](https://www.amitmerchant.com).
+
+> [Theme demo](https://www.amitmerchant.com/reverie/introducing-reverie-jekyll-theme/)
 
 This is a plug-and-play Jekyll theme which you can use on GitHub Pages without even setting up a local environment.
 
+![](/images/reverie-demo.png)
+
 ## Features
 
 - Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
@@ -9,14 +19,67 @@ This is a plug-and-play Jekyll theme which you can use on GitHub Pages without e
 - Sass/Coffeescript support using Jekyll 2.0
 - Free hosting on your GitHub Pages user site
 - Markdown blogging
+- Elegant typography
+  - Futura PT fonts (The same fonts which has been used on <https://pixar.com>)
 - Syntax highlighting using Pygments
-    - Dracula syntax theme included
+    - [Dracula syntax theme](https://draculatheme.com/) included
 - Disqus commenting
 - Google Analytics integration
 - Categorize posts out-of-the box
 - A home widget to show recent GitHub commit
 - RSS Feed
 
+## Using Reverie on GitHub Pages
+
+### Step 1) Fork Reverie to your User Repository
+
+Fork this repo, then rename the repository to `yourgithubusername.github.io`.
+
+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)
+
+### Step 2) Customize and view your site
+
+Enter your site name, description, avatar and many other options by editing the `_config.yml` file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here.
+
+Making a change to `_config.yml` (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <https://yourgithubusername.github.io> - if not, give it ten minutes as GitHub suggests and it'll appear soon.
+
+### Step 3) Publish your first blog post
+
+Create a new file called `/_posts/2019-2-13-Hello-World.md` to publish your first blog post. That's all you need to do to publish your first blog post! This [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) might come in handy while writing the posts.
+
+> You can add additional posts in the browser on GitHub.com too! Just hit the <kbd>Create new file</kbd> button in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md
+
+## Using Categories in Reverie
+
+You can categorize your content based on `categories` in Reverie. For this, you just need to add `categories` in front matter like below:
+
+For adding single category:
+
+```md
+categories: JavaScript
+```
+
+For adding multiple categories:
+
+```md
+categories: [PHP, Laravel]
+```
+
+The contegorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/>
+
+## RSS
+
+The generated [RSS feed](https://en.wikipedia.org/wiki/RSS) of your blog can be found at <https://yourgithubusername.github.io/feed>. You can see the example RSS feed over [here](https://www.amitmerchant.com/feed).
+
+## Sitemap
+
+The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>.
+
+## The name?
+
+reverie - _a state of being pleasantly lost in one's thoughts; a daydream._<br><sup>/ˈrɛv(ə)ri/</sup> 
+
+
 ## License
 
 MIT

_config.yml

@@ -12,7 +12,7 @@ author: Amit Merchant
 description: An elegant Jekyll theme
 
 # URL of your avatar or profile pic (you could use your GitHub profile pic)
-avatar: https://avatars0.githubusercontent.com/u/3647841?v=3&s=460
+avatar: /reverie/images/reverie.png
 
 #
 # Flags below are optional
@@ -52,7 +52,7 @@ enforce_ssl: https://www.amitmerchant.com/reverie
 # (http://yourusername.github.io/repository-name)
 # and NOT your User repository (http://yourusername.github.io)
 # then add in the baseurl here, like this: "/repository-name"
-baseurl: ""
+baseurl: "/reverie"
 
 #
 # !! You don't need to change any of the configuration flags below !!

_layouts/post.html

@@ -6,7 +6,7 @@ layout: default
   <h1>{{ page.title }}</h1>
 
   <div>
-    <p class="author_title">{{site.name}}  ·  {{ page.date | date: "%B %e, %Y" }}</p>
+    <p class="author_title">{{site.author}}  ·  {{ page.date | date: "%B %e, %Y" }}</p>
     {% if page.last_modified_at %}
     <p class="author_title" datetime="{{ page.last_modified_at | date_to_xmlschema }}">(Updated: {{ page.last_modified_at | date: "%b %-d, %Y" }})</p>
     {% endif %}

_posts/2019-02-03-introducing-reverie-jekyll-theme.md

@@ -1,27 +0,0 @@
----
-layout: post
-title: Introducing Reverie - An elegant Jekyll theme
-categories: [Miscellaneous, Jekyll]
----
-
-Reverie is a Jekyll theme which is simple and opinionated. It's actually a fork of [jekyll-now](https://github.com/barryclark/jekyll-now) with some additional features and personal touches which I've implemented to suit my needs for [my blog](https://www.amitmerchant.com).
-
-This is a plug-and-play Jekyll theme which you can use on GitHub Pages without even setting up a local environment.
-
-## Features
-
-- 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)
-- Sass/Coffeescript support using Jekyll 2.0
-- Free hosting on your GitHub Pages user site
-- Markdown blogging
-- Syntax highlighting using Pygments
-    - Dracula syntax theme included
-- Disqus commenting
-- Google Analytics integration
-- Categorize posts out-of-the box
-- A home widget to show recent GitHub commit
-- RSS Feed
-- SEO friendly
-
-

_posts/2019-02-13-introducing-reverie-jekyll-theme.md

@@ -0,0 +1,80 @@
+---
+layout: post
+title: Introducing Reverie - A ridiculously elegant Jekyll theme
+categories: [Miscellaneous, Jekyll]
+---
+
+[Reverie](https://github.com/amitmerchant1990/reverie) is a [Jekyll](https://jekyllrb.com/)-powered theme which is simple and opinionated. It's actually a fork of [jekyll-now](https://github.com/barryclark/jekyll-now) with some additional features and [personal touches](https://github.com/amitmerchant1990/amitmerchant1990.github.io) which I've implemented to suit my needs for [my blog](https://www.amitmerchant.com).
+
+This is a plug-and-play Jekyll theme which you can use on GitHub Pages without even setting up a local environment.
+
+![](/images/reverie-demo.png)
+
+## Features
+
+- 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)
+- Sass/Coffeescript support using Jekyll 2.0
+- Free hosting on your GitHub Pages user site
+- Markdown blogging
+- Elegant typography
+  - Futura PT fonts (The same fonts which has been used on <https://pixar.com>)
+- Syntax highlighting using Pygments
+    - [Dracula syntax theme](https://draculatheme.com/) included
+- Disqus commenting
+- Google Analytics integration
+- Categorize posts out-of-the box
+- A home widget to show recent GitHub commit
+- RSS Feed
+
+## 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`.
+
+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)
+
+### Step 2) Customize and view your site
+
+Enter your site name, description, avatar and many other options by editing the `_config.yml` file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here.
+
+Making a change to `_config.yml` (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <https://yourgithubusername.github.io> - if not, give it ten minutes as GitHub suggests and it'll appear soon.
+
+### Step 3) Publish your first blog post
+
+Create a new file called `/_posts/2019-2-13-Hello-World.md` to publish your first blog post. That's all you need to do to publish your first blog post! This [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) might come in handy while writing the posts.
+
+> You can add additional posts in the browser on GitHub.com too! Just hit the <kbd>Create new file</kbd> button in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md
+
+## Using Categories in Reverie
+
+You can categorize your content based on `categories` in Reverie. For this, you just need to add `categories` in front matter like below:
+
+For adding single category:
+
+```md
+categories: JavaScript
+```
+
+For adding multiple categories:
+
+```md
+categories: [PHP, Laravel]
+```
+
+The contegorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/>
+
+## RSS
+
+The generated [RSS feed](https://en.wikipedia.org/wiki/RSS) of your blog can be found at <https://yourgithubusername.github.io/feed>. You can see the example RSS feed over [here](https://www.amitmerchant.com/feed).
+
+## Sitemap
+
+The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>.
+
+## License
+
+MIT
+
+