|
1 | 1 | <div align="center">
|
2 | 2 | <br>
|
3 |
| - <img src="/images/reverie-text.png" alt="Reverie" width="200"/> |
4 |
| - <br> |
| 3 | + <img src="/images/flowkap.png" alt="Reverie" width="200"/> |
| 4 | + <br> |
5 | 5 | <p align="center">
|
6 |
| - <i>Support my work via <a href="https://paypal.me/AmitMerchant">Paypal</a></i> |
| 6 | + <i>Spend me a coffee if we ever meet and you like to :)</a></i> |
7 | 7 | </p>
|
8 | 8 | </div>
|
9 | 9 |
|
10 | 10 | ---
|
11 | 11 |
|
12 |
| -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. |
13 |
| - |
14 |
| -> [Theme demo](https://reverie-jekyll.netlify.app/) |
15 |
| -
|
16 |
| -This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https://pages.github.com) without even setting up a local environment. |
17 |
| - |
18 |
| - |
19 |
| - |
20 |
| -| Responsiveness | Search | Categories | |
21 |
| -|---------------------|----------------------|----------------------| |
22 |
| -| |  |  | |
23 |
| - |
24 |
| -## Features overview |
25 |
| - |
26 |
| -- Clean and minimal design |
27 |
| -- Single column post layout |
28 |
| -- Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog |
29 |
| -- Fully responsive and mobile optimized theme |
30 |
| -- Sass/Coffeescript support using Jekyll 2.0 |
31 |
| -- Free hosting on your GitHub Pages user site |
32 |
| -- All the SEO goodies come built-in |
33 |
| -- Markdown blogging |
34 |
| -- Supports [Pullquotes](https://reverie-jekyll.netlify.app/pullquotes/) |
35 |
| -- Syntax highlighting using Pygments |
36 |
| - - [Dracula syntax theme](https://draculatheme.com/) included |
37 |
| -- Disqus commenting |
38 |
| -- Social media icons |
39 |
| -- Google Analytics integration |
40 |
| -- Fuzzy search across blog posts |
41 |
| -- Blog with pagination |
42 |
| -- Categorize posts out-of-the box |
43 |
| -- RSS Feed |
44 |
| -- Built-in sitemap |
45 |
| - |
46 |
| -> <p><i>Like this theme?</i> If so, consider donating a small amount that will help my maintaining this project further.<p> |
47 |
| -> You can support me via <a href="https://paypal.me/AmitMerchant">Paypal</a>. |
48 |
| -
|
49 |
| -## Using Reverie on GitHub Pages |
50 |
| - |
51 |
| -### 1. Fork Reverie to your User Repository |
52 |
| - |
53 |
| -Fork this repository, then rename the repository to `yourgithubusername.github.io`. |
54 |
| - |
55 |
| -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. |
56 |
| - |
57 |
| -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). |
58 |
| - |
59 |
| -### 2. Customize and view your site |
60 |
| - |
61 |
| -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. |
62 |
| - |
63 |
| -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. |
64 |
| - |
65 |
| -### 3. Publish your first blog post |
66 |
| - |
67 |
| -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. |
68 |
| - |
69 |
| -> 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 |
70 |
| -
|
71 |
| -## Using Categories in Reverie |
72 |
| - |
73 |
| -You can categorize your content based on `categories` in Reverie. For this, you just need to add `categories` in front matter like below: |
74 |
| - |
75 |
| -For adding single category: |
76 |
| - |
77 |
| -```md |
78 |
| -categories: JavaScript |
79 |
| -``` |
80 |
| - |
81 |
| -For adding multiple categories: |
82 |
| - |
83 |
| -```md |
84 |
| -categories: [PHP, Laravel] |
85 |
| -``` |
86 |
| - |
87 |
| -The categorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/> |
88 |
| - |
89 |
| -## Pagination |
90 |
| - |
91 |
| -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. |
92 |
| - |
93 |
| -```yml |
94 |
| -paginate: 6 |
95 |
| -``` |
96 |
| -
|
97 |
| -## RSS |
98 |
| -
|
99 |
| -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). |
100 |
| -
|
101 |
| -## Sitemap |
102 |
| -
|
103 |
| -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://reverie-jekyll.netlify.app/sitemap). |
104 |
| -
|
105 |
| -## Emailware |
106 |
| -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! |
107 |
| -
|
108 |
| -## The name? |
| 12 | +## About |
109 | 13 |
|
110 |
| -reverie - _a state of being pleasantly lost in one's thoughts; a daydream._<br><sup>/ˈrɛv(ə)ri/</sup> |
| 14 | +This blog is based upton [Reverie](https://github.com/amitmerchant1990/reverie) and hence [Jekyll](https://jekyllrb.com/)-powered. |
111 | 15 |
|
| 16 | +To visit click [here](https://flowkap.github.io/)! |
112 | 17 |
|
113 | 18 | ## License
|
114 | 19 |
|
|
0 commit comments