mirror-crappy-reverie/README.md

151 lines
6.9 KiB
Markdown
Raw Permalink Normal View History

Reverie-Crappy is a fork of [amitmerchant1990/reverie](https://github.com/amitmerchant1990/reverie) with some adjustment.
The following has been add/edited from the original :
- Dark Theme toggle (don't respect browser preferences) with DarkReader.
- Remove . when post author doesn't present.
- change file strcture.
- ~~Post 'visiblity' when not set to public, will not be listed on site. It still appear on sitemap though.~~ changed to 'hidden: true' for pagination compatiblity.
- More expand friendly navbar.
- add gitea icon svg.
- choice to disable/enable Twitter share on buttom.
- choice to enable/disable blog on first page.
- any file contain "hidden_true" will be exclude from sitemap (via _config.yaml)
- add custom index upper(before blog)
- add seperated blog index page
2020-10-22 10:30:39 +00:00
<div align="center">
2019-02-13 06:14:36 +00:00
<br>
2023-04-18 10:18:15 +00:00
<img src="/assets/images/reverie-text.png" alt="Reverie" width="200"/>
2020-10-22 10:30:39 +00:00
<br>
2019-08-31 12:39:53 +00:00
<p align="center">
2020-10-22 10:30:39 +00:00
<i>Support my work via <a href="https://paypal.me/AmitMerchant">Paypal</a></i>
2020-11-29 19:24:59 +00:00
<i>Would you be interested in <a href="https://www.producthunt.com/upcoming/reverie-pro">Reverie Pro</a>?</i>
2019-08-31 08:33:30 +00:00
</p>
2020-10-22 10:30:39 +00:00
</div>
2019-02-13 06:14:36 +00:00
2020-10-22 10:31:34 +00:00
---
2023-04-18 10:18:15 +00:00
2019-08-31 12:33:41 +00:00
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.
2019-02-12 19:04:04 +00:00
2023-01-06 10:18:56 +00:00
> [Theme demo](https://reverie.pages.dev/)
2019-02-13 10:40:47 +00:00
2021-11-02 10:51:01 +00:00
This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https://pages.github.com) (or [Cloudflare Pages](https://pages.cloudflare.com/) if you want to have your repository private) without even setting up a local environment.
2019-02-12 19:04:04 +00:00
2023-04-18 10:18:15 +00:00
![](/assets/images/reverie-demo.png)
2019-02-13 07:00:32 +00:00
2019-07-29 05:20:15 +00:00
| Responsiveness | Search | Categories |
2019-07-29 05:13:08 +00:00
|---------------------|----------------------|----------------------|
2023-04-18 10:18:15 +00:00
|![Responsiveness](/assets/images/mobile-demo.png) | ![search](/assets/images/search.png) | ![categories](/assets/images/categories.png) |
2019-07-29 05:13:08 +00:00
2021-02-16 04:08:16 +00:00
# Table of Contents
- [Features overview](#features-overview)
- [Using Reverie on GitHub Pages](#using-reverie-on-github-pages)
- [1. Fork Reverie to your User Repository](#1-fork-reverie-to-your-user-repository)
- [2. Customize and view your site](#2-customize-and-view-your-site)
- [3. Publish your first blog post](#3-publish-your-first-blog-post)
- [Using Categories in Reverie](#using-categories-in-reverie)
- [Pagination](#pagination)
- [RSS](#rss)
- [Sitemap](#sitemap)
- [Emailware](#emailware)
- [The name?](#the-name)
- [License](#license)
2019-06-24 18:46:05 +00:00
## Features overview
2019-02-12 19:04:04 +00:00
2019-09-19 09:45:14 +00:00
- Clean and minimal design
- Single column post layout
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-09-19 09:45:14 +00:00
- Fully responsive and mobile optimized 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-10-14 04:48:33 +00:00
- All the SEO goodies come built-in
2019-02-12 19:04:04 +00:00
- Markdown blogging
2020-08-07 05:24:10 +00:00
- Supports [Pullquotes](https://reverie-jekyll.netlify.app/pullquotes/)
2019-02-12 19:04:04 +00:00
- Syntax highlighting using Pygments
2019-02-13 08:53:12 +00:00
- [Dracula syntax theme](https://draculatheme.com/) included
2019-02-12 19:04:04 +00:00
- Disqus commenting
2019-09-19 09:45:14 +00:00
- Social media icons
2019-02-12 19:04:04 +00:00
- Google Analytics integration
2021-02-16 03:54:35 +00:00
- Supports [Google Analytics 4](https://support.google.com/analytics/answer/10089681?hl=en)
2019-06-24 18:46:05 +00:00
- Fuzzy search across blog posts
2019-09-19 09:45:14 +00:00
- Blog with pagination
2019-02-12 19:04:04 +00:00
- Categorize posts out-of-the box
- RSS Feed
2019-10-14 04:48:33 +00:00
- Built-in sitemap
2019-02-12 19:04:04 +00:00
2020-10-22 10:25:22 +00:00
> <p><i>Like this theme?</i> If so, consider donating a small amount that will help my maintaining this project further.<p>
> You can support me via <a href="https://paypal.me/AmitMerchant">Paypal</a>.
2019-08-01 12:10:47 +00:00
2019-02-13 05:48:58 +00:00
## Using Reverie on GitHub Pages
2020-12-10 10:28:31 +00:00
Setting up Reverie on GitHub Pages is as simple as it gets!
2019-08-01 12:12:30 +00:00
### 1. Fork Reverie to your User Repository
2019-02-13 05:48:58 +00:00
2019-06-24 18:46:05 +00:00
Fork this repository, then rename the repository to `yourgithubusername.github.io`.
2019-02-13 05:48:58 +00:00
2019-10-14 04:48:33 +00:00
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.
2019-06-22 12:25:05 +00:00
2019-10-14 04:48:33 +00:00
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).
2019-02-13 05:48:58 +00:00
2019-08-01 12:12:30 +00:00
### 2. Customize and view your site
2019-02-13 05:48:58 +00:00
2019-02-13 07:15:18 +00:00
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.
2019-02-13 05:48:58 +00:00
2019-10-14 04:48:33 +00:00
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.
2019-02-13 05:48:58 +00:00
2019-08-01 12:12:30 +00:00
### 3. Publish your first blog post
2019-02-13 05:48:58 +00:00
2020-09-01 07:36:24 +00:00
Delete all files from `_posts`directory 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](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) might come in handy while writing the posts.
2019-02-13 05:48:58 +00:00
> 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
2019-02-13 07:15:18 +00:00
You can categorize your content based on `categories` in Reverie. For this, you just need to add `categories` in front matter like below:
2019-02-13 05:48:58 +00:00
For adding single category:
```md
categories: JavaScript
```
For adding multiple categories:
```md
categories: [PHP, Laravel]
```
2019-08-01 12:31:53 +00:00
The categorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/>
2019-02-13 05:48:58 +00:00
2019-07-28 09:28:00 +00:00
## Pagination
2019-10-14 04:48:33 +00:00
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.
2019-07-28 09:28:00 +00:00
```yml
paginate: 6
```
2019-02-13 05:48:58 +00:00
## RSS
2020-08-07 05:05:30 +00:00
Reverie comes with a [RSS feed](https://en.wikipedia.org/wiki/RSS) 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](https://reverie-jekyll.netlify.app/feed.xml).
2019-02-13 05:48:58 +00:00
## 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](https://reverie-jekyll.netlify.app/sitemap.xml).
2019-02-13 05:48:58 +00:00
2019-11-06 18:34:49 +00:00
## Emailware
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 <bullredeyes@gmail.com> about anything you'd want to say about this software. I'd really appreciate it!
2019-02-15 12:03:56 +00:00
## The name?
reverie - _a state of being pleasantly lost in one's thoughts; a daydream._<br><sup>/ˈrɛv(ə)ri/</sup>
2019-02-12 19:04:04 +00:00
## License
2019-02-13 05:48:58 +00:00
MIT