amitmerchant1990 / reverie

:art: A ridiculously elegant Jekyll theme.

Support my work via Paypal • Would you be interested in Reverie Pro?

---

Reverie is a Jekyll-powered theme which is simple and opinionated. It's actually a fork of jekyll-now with some additional features and personal touches which I've implemented to suit my needs for my blog.

Theme demo

This is a plug-and-play Jekyll theme best suited to use on GitHub Pages (or Cloudflare Pages if you want to have your repository private) without even setting up a local environment.

Responsiveness	Search	Categories

Table of Contents

• Features overview
• Using Reverie on GitHub Pages
  • 1. Fork Reverie to your User Repository
  • 2. Customize and view your site
  • 3. Publish your first blog post
• Using Categories in Reverie
• Pagination
• RSS
• Sitemap
• Emailware
• The name?
• License

Features overview

• Clean and minimal design
• Single column post layout
• Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
• Fully responsive and mobile optimized theme
• Sass/Coffeescript support using Jekyll 2.0
• Free hosting on your GitHub Pages user site
• All the SEO goodies come built-in
• Markdown blogging
• Supports Pullquotes
• Syntax highlighting using Pygments
  • Dracula syntax theme included
• Disqus commenting
• Social media icons
• Google Analytics integration
• Supports Google Analytics 4
• Fuzzy search across blog posts
• Blog with pagination
• Categorize posts out-of-the box
• RSS Feed
• Built-in sitemap

Like this theme? If so, consider donating a small amount that will help my maintaining this project further.

You can support me via Paypal.

Using Reverie on GitHub Pages

Setting up Reverie on GitHub Pages is as simple as it gets!

1. Fork Reverie to your User Repository

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

Alternatively, you can click the Use this template 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).

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.

3. Publish your first blog post

Delete all files from _postsdirectory and 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 might come in handy while writing the posts.

You can add additional posts in the browser on GitHub.com too! Just hit the Create new file button in /_posts/ to create new content. Just make sure to include the front-matter 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:

categories: JavaScript

For adding multiple categories:

categories: [PHP, Laravel]

The categorized content can be shown over this URL: https://yourgithubusername.github.io/categories/

Pagination

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.

paginate: 6

RSS

Reverie comes with a RSS feed in-built. The generated RSS Feed of your blog can be found at https://yourgithubusername.github.io/feed. You can see the example RSS feed over here.

Sitemap

The generated sitemap of your blog can be found at https://yourgithubusername.github.io/sitemap.xml. You can see the example sitemap feed over here.

Emailware

Reverie is an 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!

The name?

reverie - a state of being pleasantly lost in one's thoughts; a daydream.
^{/ˈrɛv(ə)ri/}

License

MIT

reverie's Issues

scss compilation

Hi Amit

This is a great looking theme. I followed the instructions, but the site deployed is missing assets.css. I presume the compilation step from scss to css hasn't taken. Where do I look?

Deenar

_pages doesn't seem to work properly

This probably is my fault, however: I can't seem to get my github page recognize changes to the "_pages" folder the way it should (or better: the way, I think it should).

I was able to edit the "About" page, but I couldn't add another page containing my CV nor could I delete the "Gettings started" link in the menu.

Shouldn't github recognize that I deleted the "getting-started" page, recompile the site and remove its entry from the menu?
And analogously: Shouldn't it add a menu point "CV" when I create a new page in that folder?
Any help would be appreciated :-)

styles.scss invalid US-ASCII character

I'm using reverie as a base for my site. When running this locally with:

bundle exec jekyll serve

I get:

Conversion error: Jekyll::Converters::Scss encountered an error while converting 'assets/css/style.scss':

I don't have that file in my code so I assume it's pulling it from the upstream (this repo).

How to make the header wider?

Hi, I am new to this. I want to ask how can I widen the header. The main reason is that I wanna the photo to be larger. Thanks for your help.

Remove or refactor unused CSS

The styles.scss contains a lot of CSS which is potentially unused in the theme - from carbon ads styling to what appears to be CSS for a timeline.
I would greatly appreciate it if the CSS which is not needed for the theme would either be removed or put into a separate file or clearly commented, so I can safely remove it from my repository.

Thanks and keep up the good work!

Not able to set up locally

It is great that whenever I make changes. It is working fine but It's not good practice to commit and push the code on GitHub to see the changes.

I tried to running locally but it's not working.

Update _includes/meta.html og:site_name property

Update meta.html for the og:site_name property.

From <meta property="og:site_name" content="Amit Merchant - Software Engineer"/>

To <meta property="og:site_name" content="{{ site.name }}"/>

Sincerely,
Mike

Not able to host the on github pages

I tried using Use this template but not able to host on github pages.

Here is my instance: https://therajanmaurya.github.io/

Getting this

Historical unlicensed font causing legal liability issues for template users

Hi, I don't think there's much to be done about this now, but I want whoever created this template to know that having used it I recently got chased for payment for a proprietary font that was included in the original template. I have paid the fee to settle the matter, and hopefully that's the end of it, however I want it to be known that it's incredibly uncool, not to mention illegal, to take a font from somewhere else without a license.

I see that it was removed in f831df5 but that does nothing to stop the font licensor coming after any site that used that version of this template with the unlicensed font, as they are entitled to do.

It's bad enough that the font used unlicensed in this project. It's 100x worse that it's a template that exposed anyone who used this template to legal liability for font licensing violation.

💸 🧑‍⚖️

Alt Text for Header Logo

No alt text for the logo in the header is showing for me. I believe this is because the alt is currently set to site.title (which doesn't seem to exist).

Hi, how to run this locally? jekyll serve does not work?

Hey! Great job with this theme.

I was wondering: If I want to run this locally (to do quicker debugging), how would I go about doing that? Seems like jekyll serve does not work.

Thanks,
Henrik

Any way to make images open in popup

I want to show some large images in my blog. Any change to have these opened in a sort of lightbox kinda way?

Great template, thanks!https://guides.github.com/features/mastering-markdown/

Code always has double scrollbars

If you use code (indent 4 spaces or triple backquote fenced code), you get two sets of scroll bars around your code. Occurs on the demo page too:

I would expect that code to have no scroll bars. Code that is too wide for the page should have only the necessary scroll bar (horizontal) and only one of them.

Looks like the code looks like this in the source:

```md
categories: JavaScript
```

Since it happens in the demo, I assume this is a bug and not me doing something wrong.

Occurs in both browsers I tested:

• Chrome Version 79.0.3945.117 (Official Build) (64-bit) (in incognito)
• Microsoft Edge 44.17763.831.0 with Microsoft EdgeHTML 18.17763

How do I remove/change the favicon?

How do I remove/change the favicon? I've gone through all the files, so I must have overlooked something.

Ruby version 2.4.3 is no longer supported

Hi, this theme looks awesome!

This ruby version is past its end of life and I had some trouble running it locally.
I didn't have this ruby version installed, so I ran rbenv install 2.4.3, but it couldn't install and got some errors:

Installing ruby-2.4.3...

WARNING: ruby-2.4.3 is past its end of life and is now unsupported.
It no longer receives bug fixes or critical security updates.

[...]
BUILD FAILED (macOS 13.5.2 using ruby-build 20230608)

Jekyll's guide also suggests using 2.5.0 or higher - https://jekyllrb.com/docs/

I tried running it with version 2.7.3 and it was working fine.
What would be the best action here?
Do we still need the .ruby-version file? I saw some suggestions about removing the file - #57

Font licensing

Futura PT is a commercial font that needs commercial font licenses paid for its use. Distributing it in this repository is likely a copyright violation, and you should consider switching to an openly licensed font.

https://www.myfonts.com/fonts/paratype/futura-book/

One resource for finding fonts appropriately licensed for open web usage is Google Fonts: https://fonts.google.com/

Semi-related you should be aware that using "Light" weights of fonts for body text can make long-form reading tough, which may be the opposite of what you want in a blog setting.

Bold does not work

bold text passage look exactly the same as non-bold texts. Similarily, bold-and-italics can not be distinguished from italics only.

template not working

"use this template" way didn't work for me

I even did step 2 - and I customized it with the url of the github repo with my username, but it is still not working. Is the "Use my template" method working properly? I'm not really sure what else the error could be.

Migrating from jekyll-now?

For anyone that has decided to follow your fork of jekyll-now, do you have any migration instructions? Are there specific files I can simply replace in my existing blog project, or do you recommend just doing a nuke-and-pave for everything but the posts?

Add support for Mastodon URL in socials

Given the current demise of Twitter, and the rise of Mastodon, it would be great to have the option to define a Mastodon profile URL, represented by an icon. 🤞

Horizontal scroll bar on iOS

On my iPhone X, I get a horizontal scroll bar with safari.

Dark Mode

Hi!
Thanks for this! Really good. Is there anyay to get dark mode for this theme, cause I would like the code to match the backgorund of the site. Thanks!

Hardcoded property in meta.html

There's a hardcoded property (og:site_name) in meta.html which might be overlooked while creating forks:

reverie/_includes/meta.html

Line 26 in 83727d2

<meta property="og:site_name" content="Amit Merchant - Software Engineer"/>

Maybe you can edit this property out or add a disclaimer to README.md.

Just FYI :)

Support empty titles

Do you plan to support posts with empty titles? If so, I could open a pull request if you are interested. I am falling back to the excerpt if no title is given.

Code blocks dont have rounded corners

Default :

Codeblocks should have rounded corners like this :

Google Analytics

It looks like there may be a newer way for Google Analytics to track sites using a number like (G-LQYVJMTX20) which is called a Measurement ID.

My first time through the Google Analytics wizard I created and used this Measurement ID, and put that into the config.yml file but it didnt work. After I reran the Google Analytic wizard a second time I saw a somewhat obscured option for enabling a UA number. I checked that box and got a UA number that works for Blog site.

It might be nice to look into the Measurement ID and see if Reverie could work with that as that was the default option when setting up Google Analytics.

Question: How to change from the Minima theme to Reverie?

Hi,

I hope this is the right place to ask this.

I have an existing GitHub Pages blog that uses the default Minima theme for Jekyll. I tried changing to Reverie by installing the gem and changing the theme in _config.yml but the result looks quite bad. One issue is that /assets/main/style.css is missing but having fixed that, things still don't look well.

My question is - Is it possible to change from Minima to Reverie and not have to install Reverie fresh? Might there be instructions for how to do this online somewhere?

Thanks,
urig

Funding is setup incorrectly

Clicking the "Sponsor" button on this github page gives an error:

Some errors were encountered when parsing the FUNDING.yml file:

Some users provided are not enrolled in GitHub Sponsors. Apply to Sponsors.
Learn more about formatting FUNDING.yml.

Maybe you need to remove the github line until you're accepted into their funding program?

How to use pullquotes and modify the style of quotes?

Hi,

Thanks for your edition of Reverie!

I'm fairly new to anything tech related so my questions may well be dumb:

1. What's the syntax to create a pullquote while writing a .md page?
2. How can I change the background colour of the quotes created by the regular "> " method?

Thank you again for your attention!

[Broken Link] Readme points to broken links

The link to the sitemap and rss feed (edit: my README version was out of date. RSS link works) is broken. Perhaps you will want to add ".xml" on the links.

Example: https://reverie-jekyll.netlify.app/sitemap
Proposed Solution: https://reverie-jekyll.netlify.app/sitemap.xml

Collection post won't show up in categories

The Categories page works fine for posts in the _posts folder, but my posts in a collection I created will not show there. The collection's folder is called _clusters, I modified the _config.yml file as shown below but it will not work

include: ['_pages', '_clusters']

collections:
  clusters:
    output: true

Any help will be much appreciated

Where is header.html ?

I wanted to edit the looks of header.html that is responsible for the topmost header -

I can see that in _layouts folder, in default.html you include header.html but I don't see that file in _includes folder -

<!DOCTYPE html>
<html lang="{{ page.lang | default: site.lang | default: "en" }}">

  {% include head.html %}

  <body>

    {% include header.html %}

    <main class="page-content" aria-label="Content">
      <div class="wrapper">
        {{ content }}
      </div>
    </main>

    {% include footer.html %}

  </body>

</html>

How are you including header.html ?

How to update/change the font of your text in posts and pages

Hello there, I recently started using this template and I was wondering if there is a way documented to updating the fonts of the posts and pages. I am not fully satisfied with the font of my posts and pages and would like to be able to change those with something of my liking. Do you have any comments on this? Thanks,

Dropcap issue

Adding drop cap using p:first-child:first-letter also affects the first letter in the blockquote. Is there a way to exclude the blockquote from being affected?

Help on turning on text wrap in block codes

Not an actual issue, just a question. Does anyone know who can I turn on text wrapping in code blocks? Pretty simple, in the example below, I want the remaining text in the line to wrap and be visible below, instead of enable scrolling.

I tried messing around with word-wrap, word-break and overflow inside _darcula.scss and _highlights.scss, changing things inside .highlight and .highlighter-rouge, but my CSS skills are lacking.

Any help is appreciated.

Mastodon comment section

Hi,
there is a nice way to add a comment section via Mastodon (found here)

I've added this to my page with this commit in case you (or anyone else) is interested.

jekyll-scholar

Currently, I am trying to add some references/bibliography to my blog post through jekyll-scholar. It is working fine on local, but github cannot recognize the citations(the plugin is not recognized). How can I solve this problem?

Specifically, github returns this error:

The tag cite on line 1 in _posts/.....md is not a recognized Liquid tag.

Where cite is used as shown here.

How to set About section to "primary" page?

Hi,
I am not familiar with HTML, so please excuse if this is really stupid and trivial - But how would I set the About section to be the primary page, in the sense that it is the one that appears first if one calls "username.github.io" or clicks on the logo or blog title?

Thanks in advance!

Small Typo on /_posts/2019-8-12-code-snippets.md

Dracula is missing the 'c' on ln 7

Good time to apply this.

          Thanks for the PR @Kolossi.

I would just suggest you move the logic to _includes/analytics.html file instead of creating a separate file. As I think, all the analytics code should live in a single file so it becomes more maintainable.

Thanks!

Originally posted by @amitmerchant1990 in #48 (comment)

Creating from the template not working

Hi - I clicked the use from template button to create my site from the template, and it's not elegant or working... This is all I've done. Not sure why it's not working. Take a look: https://pdwaggoner.github.io/ Any help is welcomed. Thanks!

looses the default styling

The default styling goes for a toss. Please see https://krishanu.co.in/

I am not a coder, therefore, not sure how to fix it.