Skip to content

Commit 00d06a8

Browse files
Create getting-started.md
1 parent 73d3e38 commit 00d06a8

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

_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).

0 commit comments

Comments
 (0)