Skip to content

Commit 7484436

Browse files
Merge branch 'master' into dev-w3c
2 parents 95061c7 + 9e98388 commit 7484436

19 files changed

+188
-40
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ _site
44
.jekyll-metadata
55
.bundle
66
.sass-cache
7-
Gemfile
87
Gemfile.lock
98
node_modules
109
package.json
10+
*.gem
11+
*.gemspec
12+
.jekyll-cache

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.4.3

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
<h1 align="center">
22
<br>
3-
<img src="/images/reverie-text.png" alt="Reverie" width="200">
3+
<img src="/images/reverie-text.png" alt="Reverie" width="200"/>
44
<br>
5+
<p align="center">
6+
<a href="https://ko-fi.com/Y8Y2QC9Y"><img src="https://www.ko-fi.com/img/githubbutton_sm.svg" alt="Ko-fi" width="200"/></a>
7+
</p>
58
</h1>
69

7-
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).
10+
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.
811

912
> [Theme demo](https://www.amitmerchant.com/reverie/introducing-reverie-jekyll-theme/)
1013
@@ -18,23 +21,27 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
1821

1922
## Features overview
2023

24+
- Clean and minimal design
25+
- Single column post layout
2126
- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
22-
- Fully responsive and mobile optimized base theme
27+
- Fully responsive and mobile optimized theme
2328
- Sass/Coffeescript support using Jekyll 2.0
2429
- Free hosting on your GitHub Pages user site
25-
- All the SEO goodies comes in-built
30+
- All the SEO goodies come built-in
2631
- Markdown blogging
32+
- Supports [Pullquotes](https://en.wikipedia.org/wiki/Pull_quote)
2733
- Syntax highlighting using Pygments
2834
- [Dracula syntax theme](https://draculatheme.com/) included
2935
- Disqus commenting
36+
- Social media icons
3037
- Google Analytics integration
3138
- Fuzzy search across blog posts
32-
- Pagination of posts works out-of-the-box.
39+
- Blog with pagination
3340
- Categorize posts out-of-the box
3441
- RSS Feed
35-
- In-built sitemap
42+
- Built-in sitemap
3643

37-
> <p><i>Like this theme?</i> Become a patreon to support my opensource work <p>
44+
> <p><i>Like this theme?</i> Become a patreon to support my open source work <p>
3845
> <a href="https://www.patreon.com/amitmerchant"><img src="https://c5.patreon.com/external/logo/[email protected]" width="160"></a>
3946
4047
## Using Reverie on GitHub Pages
@@ -43,15 +50,15 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
4350

4451
Fork this repository, then rename the repository to `yourgithubusername.github.io`.
4552

46-
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.
53+
Alternatively, you can click the [`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.
4754

48-
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.
55+
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).
4956

5057
### 2. Customize and view your site
5158

5259
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.
5360

54-
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.
61+
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.
5562

5663
### 3. Publish your first blog post
5764

@@ -79,19 +86,22 @@ The categorized content can be shown over this URL: <https://yourgithubusername.
7986

8087
## Pagination
8188

82-
Pagination of posts in Reverie works out-of-the-box. You only need to specify number of posts you want on a single page in `_config.yml` and Reverie will take care of the rest.
89+
Pagination of posts in Reverie works out-of-the-box. You only need to specify the number of posts you want on a single page in `_config.yml` and Reverie will take care of the rest.
8390

8491
```yml
8592
paginate: 6
8693
```
8794
8895
## RSS
8996
90-
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).
97+
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/reverie/feed.xml).
9198
9299
## Sitemap
93100
94-
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).
101+
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/reverie/sitemap).
102+
103+
## Emailware
104+
Reverie is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this theme or it has helped you in any way, I'd like you send me an email at <[email protected]> about anything you'd want to say about this software. I'd really appreciate it!
95105
96106
## The name?
97107

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ author: Amit Merchant
1212
description: An elegant Jekyll theme
1313

1414
# URL of your avatar or profile pic (you could use your GitHub profile pic)
15-
avatar: /reverie/images/reverie.png
15+
avatar: /images/reverie.png
1616

1717
#
1818
# Flags below are optional
@@ -41,7 +41,7 @@ footer-links:
4141
disqus:
4242

4343
# Enter your Google Analytics web tracking code (e.g. UA-2110908-2) to activate tracking
44-
google_analytics: UA-43339302-4
44+
google_analytics: UA-43339302-11
4545

4646
# Your website URL (e.g. http://amitmerchant1990.github.io or http://www.amitmerchant.com)
4747
# Used for Sitemap.xml and your RSS feed

_includes/meta.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<meta property="og:image" content="{{ site.url }}{{ page.image }}"/>
2121
<meta property="twitter:image" content="{{ site.url }}{{ page.image }}"/>
2222
{% else %}
23-
<meta property="og:image" content="https://avatars0.githubusercontent.com/u/3647841?v=3&s=460"/>
24-
<meta property="twitter:image" content="https://avatars0.githubusercontent.com/u/3647841?v=3&s=460"/>
23+
<meta property="og:image" content="{{ site.url }}{{ site.avatar }}"/>
24+
<meta property="twitter:image" content="{{ site.url }}{{ site.avatar }}"/>
2525
{% endif %}
2626
<meta property="og:site_name" content="Amit Merchant - Software Engineer"/>

_includes/pullquote.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ include.quote }}<span data-pullquote="{{ include.quote }}"></span>

_layouts/default.html

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,12 @@
55
{% seo title=false %}
66
{% include meta.html %}
77

8-
<link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/style.css" />
8+
<link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/assets/style.css" />
99
<link rel="alternate" type="application/rss+xml" title="{{ site.name }} - {{ site.description }}" href="{{ site.baseurl }}/feed.xml" />
1010
<link rel="canonical" href="{{ site.url }}{{ page.url }}" />
1111

1212
<meta name="theme-color" content="#000000">
13-
<link rel="icon" type="image/png" sizes="32x32" href="/reverie/images/favicon-32x32.png">
14-
<script type="text/javascript">
15-
var host = "www.amitmerchant.com";
16-
if ((host == window.location.host) && (window.location.protocol != "https:"))
17-
window.location.protocol = "https";
18-
</script>
13+
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.baseurl }}/images/favicon-32x32.png">
1914
</head>
2015

2116
<body>
@@ -33,6 +28,7 @@ <h1 class="site-name"><a href="{{ site.baseurl }}/">{{ site.name }}</a></h1>
3328

3429
<nav>
3530
<a href="{{ site.baseurl }}/">Home</a>
31+
<a href="{{ site.baseurl }}/getting-started">Getting Started</a>
3632
<a href="{{ site.baseurl }}/search">Search</a>
3733
<a href="{{ site.baseurl }}/about">About</a>
3834
</nav>

_pages/categories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Categories
1616
<a name="{{ category_name | slugize }}"></a>
1717
{% for post in site.categories[category_name] %}
1818
<article class="archive-item">
19-
<h4><a href="{{ site.baseurl }}{{ post.url }}">{{post.title}}</a></h4>
19+
<h4><a href="{{ site.baseurl }}{{ post.url }}">{% if post.title and post.title != "" %}{{post.title}}{% else %}{{post.excerpt |strip_html}}{%endif%}</a></h4>
2020
</article>
2121
{% endfor %}
2222
</div>

_pages/getting-started.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: page
3+
title: Getting started with Reverie
4+
permalink: /getting-started/
5+
---
6+
7+
### Step 1) Fork Reverie to your User Repository
8+
9+
Fork [this repository](https://github.com/amitmerchant1990/reverie), then rename the repository to `yourgithubusername.github.io`.
10+
11+
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.
12+
13+
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)
14+
15+
### Step 2) Customize and view your site
16+
17+
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.
18+
19+
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.
20+
21+
### Step 3) Publish your first blog post
22+
23+
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.
24+
25+
> 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
26+
27+
## Using Categories in Reverie
28+
29+
You can categorize your content based on `categories` in Reverie. For this, you just need to add `categories` in front matter like below:
30+
31+
For adding single category:
32+
33+
```md
34+
categories: JavaScript
35+
```
36+
37+
For adding multiple categories:
38+
39+
```md
40+
categories: [PHP, Laravel]
41+
```
42+
43+
The contegorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/>
44+
45+
## RSS
46+
47+
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/reverie/feed).
48+
49+
## Sitemap
50+
51+
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/reverie/sitemap).

_pages/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ permalink: /search/
99
<ul id="results-container"></ul>
1010
</div>
1111

12-
<script src="{{ site.baseurl }}/js/simple-jekyll-search.min.js" type="text/javascript"></script>
12+
<script src="{{ site.baseurl }}/assets/simple-jekyll-search.min.js" type="text/javascript"></script>
1313

1414
<script>
1515
SimpleJekyllSearch({

0 commit comments

Comments
 (0)