minoplhy/crappy-reverie
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Riccardo Di Maio 2019-10-14 12:48:33 +08:00 committed by GitHub
parent 225b9e1719
commit adf46bed3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -27,7 +27,7 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
- Fully responsive and mobile optimized theme - Fully responsive and mobile optimized theme
- Sass/Coffeescript support using Jekyll 2.0 - Sass/Coffeescript support using Jekyll 2.0
- Free hosting on your GitHub Pages user site - Free hosting on your GitHub Pages user site
- All the SEO goodies comes in-built - All the SEO goodies come built-in
- Markdown blogging - Markdown blogging
- Syntax highlighting using Pygments - Syntax highlighting using Pygments
- [Dracula syntax theme](https://draculatheme.com/) included - [Dracula syntax theme](https://draculatheme.com/) included
@ -38,9 +38,9 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
- Blog with pagination - Blog with pagination
- Categorize posts out-of-the box - Categorize posts out-of-the box
- RSS Feed - RSS Feed
- In-built sitemap - Built-in sitemap
> <p><i>Like this theme?</i> Become a patreon to support my opensource work <p> > <p><i>Like this theme?</i> Become a patreon to support my open source work <p>
> <a href="https://www.patreon.com/amitmerchant"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"></a> > <a href="https://www.patreon.com/amitmerchant"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"></a>
## Using Reverie on GitHub Pages ## Using Reverie on GitHub Pages
@ -49,15 +49,15 @@ This is a plug-and-play Jekyll theme best suited to use on [GitHub Pages](https:
Fork this repository, then rename the repository to `yourgithubusername.github.io`. Fork this repository, then rename the repository to `yourgithubusername.github.io`.
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. 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.
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. 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 ### 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. 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. 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 ### 3. Publish your first blog post
@ -85,7 +85,7 @@ The categorized content can be shown over this URL: <https://yourgithubusername.
## Pagination ## Pagination
Pagination of posts in Reverie works out-of-the-box. You only need to specify number of posts you want on a single page in `_config.yml` and Reverie will take care of the rest. 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.
```yml ```yml
paginate: 6 paginate: 6