Simorq

Simorq is a minimal Jekyll theme for blogging. With a simple config file change, you can easily use it to set up your own personal blog.

This project started as a fork of the klise theme, which is available here.

For Persian date support, I used the jekyll-jalali plugin written by Mehdi Sadeghi, who also has a lot of great content on his blog — definitely worth visiting if you plan to use Jekyll.

Update

In the latest update, the jekyll-jalali plugin and the Persian number conversion scripts were replaced with the persiandate script.

This theme uses the Vazirmatn font, a beautiful work by Rastikerdar, for whom I am very grateful, and Comic Mono for inline code.

Features

• Dark and light theme
• Persian date support
• Appearance customization via scss
• Responsive for desktop and mobile
• Proper image structure (jekyll-postfiles)
• Sitemap (jekyll-sitemap)
• RSS feed (jekyll-feed)
• Code highlighting (Comic Mono)
• Post pagination
• Comment support. To add a comments section using Mastodon, read this post.
• Google Analytics if you want to use it. (Please don’t 😠)
• W3C support 👽
• Font Awesome support 👽
• Lightweight and fast 🚄

Installation

To run a local server on your system:

$ git clone https://github.com/mhdzli/simorq.git
$ cd simorq
$ bundle install
$ bundle exec jekyll serve

You can view the result in your browser at localhost:4000.

Limitations

• Since jekyll-postfiles and jekyll-jalali are not supported on github pages, you cannot use this theme directly on GitHub Pages. However, you can use netlify.com, vercel.com, or surge.sh.

Update

With the addition of jekyll to GitHub Actions, you can now also deploy Simorq on GitHub. Simply set the Build and deployment option to GitHub Actions in the Pages section of your repository settings, then build and deploy using Jekyll. You can see a live example here.

License

A free and open-source project licensed under MIT.