README.md in jekyll-theme-mehdix-rtl-0.1.1 vs README.md in jekyll-theme-mehdix-rtl-0.1.2
- old
+ new
@@ -1,8 +1,8 @@
# jekyll-theme-mehdix-rtl [](https://badge.fury.io/rb/jekyll-theme-mehdix-rtl)
-
+
This is the jekyll theme used for my personal Persian [website](http://mehdix.ir). Persian aka Farsi is written right-to-left, however some people use Roman script to write Persian language in messaging applications and social networks.
During the last few years people have reached out to me asking how to setup a persian Jekyll website with Jalali calendar support. Since Jekyll now supports themes, I created this theme based on my website to help others to bootstrap their own websites.
@@ -39,10 +39,19 @@
You can override theme style by creating matching files with the same structure inside your Jekyll source tree. See Jekyll [Themes docs](https://jekyllrb.com/docs/themes/) for more information on that.
## Further customization
+### Layouts
+The following layouts are available for your homepage:
+- home: post titles along with an excerpt and pagination
+- minimal: only post titles
+
+### Comments
+In order to enalbe disqus comments add `disqus: true` to your `_config.yml` file.
+
+### Forcing RTL code blocks
If you put code blocks and they appear incorrectly, you can use _Markright gem. First add it to your Gemfile:
```ruby
gem "jekyll-markright"
```
@@ -55,6 +64,6 @@
## License
-[MIT](http://opensource.org/licenses/MIT)
\ No newline at end of file
+[MIT](http://opensource.org/licenses/MIT)