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

88 lines
4.0 KiB
Markdown
Raw Normal View History

2019-02-12 19:04:04 +00:00
---
layout: post
title: Introducing Reverie - A ridiculously elegant Jekyll theme
2019-02-12 19:04:04 +00:00
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 which I've implemented to suit my needs for [my blog](https://www.amitmerchant.com).
2019-02-12 19:04:04 +00:00
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)
2019-06-24 18:46:05 +00:00
## Features overview
2019-02-12 19:04:04 +00:00
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
2019-07-28 09:28:00 +00:00
- Fully responsive and mobile optimized base theme
2019-02-12 19:04:04 +00:00
- Sass/Coffeescript support using Jekyll 2.0
- Free hosting on your GitHub Pages user site
2019-07-28 09:28:00 +00:00
- All the SEO goodies comes in-built
2019-02-12 19:04:04 +00:00
- Markdown blogging
- Syntax highlighting using Pygments
- [Dracula syntax theme](https://draculatheme.com/) included
2019-02-12 19:04:04 +00:00
- Disqus commenting
- Google Analytics integration
2019-06-24 18:46:05 +00:00
- Fuzzy search across blog posts
2019-07-28 09:28:00 +00:00
- Pagination of posts works out-of-the-box.
2019-02-12 19:04:04 +00:00
- Categorize posts out-of-the box
- RSS Feed
2019-06-24 18:46:05 +00:00
- In-built sitemap
<div style="text-align: center;">
<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CK7DK2QJ&placement=notepadjsorg" id="_carbonads_js"></script>
</div>
## Using Reverie on GitHub Pages
### Step 1) Fork Reverie to your User Repository
2019-06-24 18:46:05 +00:00
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)
### 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
2019-06-24 18:46:05 +00:00
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
MIT
2019-02-12 19:04:04 +00:00