mirror of
https://github.com/minoplhy/crappy-reverie.git
synced 2024-12-22 13:07:56 +00:00
Update README.md
This commit is contained in:
parent
1b65470340
commit
07b7b4dc07
48
README.md
48
README.md
@ -17,6 +17,52 @@ This is a plug-and-play Jekyll theme which you can use on GitHub Pages without e
|
||||
- A home widget to show recent GitHub commit
|
||||
- RSS Feed
|
||||
|
||||
## Using Reverie on GitHub Pages
|
||||
|
||||
### Step 1) Fork Reverie to your User Repository
|
||||
|
||||
Fork this repo, then rename the repository to `yourgithubusername.github.io`.
|
||||
|
||||
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)
|
||||
|
||||
### Step 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.
|
||||
|
||||
### Step 3) Publish your first blog post
|
||||
|
||||
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.
|
||||
|
||||
> 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
|
||||
|
||||
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:
|
||||
|
||||
```md
|
||||
categories: JavaScript
|
||||
```
|
||||
|
||||
For adding multiple categories:
|
||||
|
||||
```md
|
||||
categories: [PHP, Laravel]
|
||||
```
|
||||
|
||||
The contegorized content can be shown over this URL: <https://yourgithubusername.github.io/categories/>
|
||||
|
||||
## RSS
|
||||
|
||||
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).
|
||||
|
||||
## Sitemap
|
||||
|
||||
The generated sitemap of your blog can be found at <https://yourgithubusername.github.io/sitemap>.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
MIT
|
||||
|
Loading…
Reference in New Issue
Block a user