Skip to content
/ simorq Public

A Jekyll theme for Persian blogs with khorshidi/jalali Date support.

License

Notifications You must be signed in to change notification settings

mhdzli/simorq

Repository files navigation

سیمرغ

سیمرغ قرار است یک تم Jekyll برای فارسی نویسی باشد. یک تم مینیمال که با تغییر فایل کانفیگ به راحتی بتوانید آن را برای راه‌اندازی وبلاگ شخصی خودتان استفاده کنید.

می‌توانید نمونه استفاده شده آن را در وبلاگ من ببینید. من برای خودم بخش‌های دیگری به سیمرغ اضافه کردم و تم آن را کمی تغییر داده‌ام. چنانچه دوست داشتید می‌توانید از آنها هم استفاه کنید.

برای شروع این پروژه یک فورک از تم klise استفاده شده است که اینجا در دسترس است.

برای فارسی کردن تاریخ‌ها از پلاگین jekyll-jalali استفاده کردم که مهدی صادقی گرامی نوشته و کلی مطلب مفید هم در وبلاگش دارد که اگر تصمیم دارید از Jekyll استفاده کنید حتما بهش سر بزنید.

در آخرین به روز رسانی سیمرغ پلاگین jekyll-jalali و اسکریپت‌های فارسی کردن اعداد تاریخ با اسکریپت persiandate جایگزین شدند.

در این تم از فونت‌های وزیر متن استفاده شده است که از کارهای زیبای آقای راستی‌کردار است که از ایشان بسیار ممنونم و Comic Mono برای کدهای درون متن.

قابلیت‌ها

  • تم تاریک و روشن
  • پشتیبانی از تاریخ فارسی
  • تغییر ظاهر با استفاده از scss
  • هماهنگ با دسکتاپ و گوشی
  • ساختار مناسب برای عکس‌ها (jekyll-postfiles)
  • نقشه سایت (jekyll-sitemap)
  • خوراک rss (jekyll-feed)
  • هایلایت کدها (Comic Mono)
  • صفحه بندی پست‌ها
  • آنالیز گوگل اگر دوست دارید استفاده کنید. (نکنید 😠)
  • استفاده از W3C 👽
  • استفاده از فونت Awesome 👽
  • سبک و سریع 🚄
  • برای افزودن بخش دیدگاه‌ها با استفاده از ماستودون این پست را بخوانید.

نصب

راه انداختن سرور local روی سیستم شخصی:

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

با آدرس localhost:4000 می‌توانید نتیجه را در مرورگرتان مشاهده کنید.

دیپلوی در Netlify دیپلوی با Vercel

نصب با استفاده از داکر

در این روش نیازی به نصب هیچ افزونه و زبان برنامه نویسی ای نیست. صرفا میبایست داکر روی سیستم شما نصب باشد.

git clone https://github.com/mhdzli/simorq.git
cd simorq

پس از آن میباید فایل image ساخته شود. دقت کنید این کار فقط نیاز است یک بار انجام شود و برای بارهای بعد می‌توانید از ایمیج ساخته شده استفاده کنید.

scripts/docker_build_image.sh

‍سپس می‌توانید با دستور زیر سایت را روی سیستم لوکال خود مشاهده کنید.

scripts/docker_run.sh

محدودیت‌ها

  • از آنجا که پلاگین jekyll-postfiles و jekyll-jalali در github pages پشتیبانی نمی‌شوند امکان استفاده روی گیتهاب وجود ندارد. به روز رسانی: با توجه به افزوده شدن jekyll به GitHub Actions می‌توانید از سیمرغ روی گیتهاب هم خروجی بگیرید. کافیست در بخش ‍‍‍‍‍‍Pages در تنظیمات مخزن خودتان گزینه Build and deployment را روی GitHub Actions تنظیم کنید و در بخش Actions با استفاده از ‍Jekyll خروجی بگیرید و روی دامنه مورد نظرتان راه‌اندازی کنید. می‌توانید نمونه‌ای از این خروجی را اینجا ببینید. می‌توانید از netlify.com، vercel.com یا surge.sh هم استفاده کنید.

مجوز

یک پروژه آزاد با مجوز MIT.

هواداری

اگر از این پروژه بهره بردید می‌توانید از آن حمایت کنید:

payping

hamibash