jektex

المكون الإضافي لـ Jekyll لعرض Latex المخبأ من جانب الخادم ، بدعم من وحدات الماكرو. استمتع براحة LaTex و Markdown دون تشوش موقعك مع JavaScript المتضخمة. تم تأييد هذا المشروع بواسطة Katex.org.

سمات

• يقدم صيغ اللاتكس أثناء عرض Jekyll
• يعمل بدون أي جافا سكريبت من جانب العميل
• أسرع من أي عارض اللاتكس Jekyll من جانب الخادم
• يدعم وحدات الماكرو العالمية المعرفة من قبل المستخدم
• لديه نظام التخزين المؤقت I/O كفاءة
• يعلم ديناميكيًا عن عدد التعبيرات أثناء التقديم
• من السهل جدًا الإعداد
• لا تتداخل مع سير عمل Jekyll وهيكل المشروع
• علامات تعبيرات غير صالحة في المستند ، وطباعة موقعها أثناء التقديم
• يمكن تكوينه بشكل كبير مع الافتراضات المعقولة
• تأكد من أن ذاكرة التخزين المؤقت لا تحتوي على تعبير يتم تقديمه بتكوين قديم
• يدعم اثنين من الترميز الرئيسيين اللاتكس

الاستخدام

يدعم Jektex كلاً من تدوين Kramdown Math المدمج ، وتدوين الرياضيات الأحدث فقط.

تدوين كرامون

صيغة مضمنة
ضع الصيغة بين زوجين من علامات الدولار ( $$ ) داخل الفقرة.

Lorem ipsum dolor sit amet, consectetur $$ e^{i theta }= cos ( theta )+i sin ( theta ) $$
adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

عرض الصيغة
ضع الصيغة بين زوجين من علامات الدولار ( $$ ) وأحيطها بخطين فارغين.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.

$$ left [ frac {- hbar ^2}{2 mu } nabla ^ 2 + V( mathbf {r},t) right ] Psi ( mathbf {r},t) $$

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
ea commodo consequat.

لماذا لا تستخدم Jektex $ التقليدية للصيغ المضمنة و $$ double $ لوضع العرض؟
هذه هي الطريقة التي يعمل بها Kramdown (Jekyll's Marmdown Parser) لذلك قررت احترام هذه الاتفاقية. يجعل هذا البرنامج المساعد أكثر اتساقا وعالمية. انظر هذه المسألة لمزيد من السياق.

تدوين وضع الرياضيات اللاتكس

صيغة مضمنة
ضع الصيغة بين قوسين هاربين ( ) . موقفه في النص لا يهم.

Lorem ipsum dolor sit amet, consectetur ( e^{i theta }= cos ( theta )+i sin ( theta ) )
adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

عرض الصيغة
ضع الصيغة بين قوسين مربعين هربا [ ] . موقفه في النص لا يهم.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.

[ left [ frac {- hbar ^2}{2 mu } nabla ^2 + V( mathbf {r},t) right ] Psi ( mathbf {r},t) ]

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
ea commodo consequat.

شعار ماكرو

هناك بناء في Macro لشعار Jektex. يمكنك استخدامه كـ jektex .

تكوين

Jektex Si قابلة للتكوين بشكل كبير عبر ملف _config.yml الخاص بك.

تعطيل ذاكرة التخزين المؤقت
يمكنك تعطيل التخزين المؤقت مع disable_disk_cache = true في _config.yml . يتم تمكين التخزين المؤقت بشكل افتراضي. يمكنك العثور على مزيد من المعلومات على موقع Jekyll الرسمي.

تعيين موقع ذاكرة التخزين المؤقت
بشكل افتراضي ، سيتم حفظ ذاكرة التخزين المؤقت Jektex في دليل. .jekyll-cache . ينتج عن هذا حذفه عند استدعاء jekyll clean . لمنع حذف ذاكرة التخزين المؤقت أو لتغيير موقع ذاكرة التخزين المؤقت ، يمكنك تحديد cache_dir في _config.yml :

 jektex :
  cache_dir : " .jektex-cache "

تجاهل الملفات
بشكل افتراضي ، يحاول Jektex تقديم LaTeX في جميع الملفات التي يتم تقديمها بواسطة Jekyll. قد يكون هذا في بعض الأحيان غير مرغوب فيه ، على سبيل المثال عند تقديم تغذية RSS مع مقتطفات تحتوي على LaTex. Jektex يحل هذا باستخدام خيار ignore :

 jektex :
  ignore : ["*.xml", "README.md", "_drafts/*" ]

يمكنك استخدام البطاقات البرية التقليدية باستخدام * . يتجاهل تكوين المثال هذا جميع ملفات .xml و README.md وجميع الملفات في دليل _drafts .

هناك طريقة أخرى لتجاهل المنشورات المحددة وهي تعيين سمة jektex في المسألة الأمامية إلى false :

---
title : " How Jektex works "
category : " Development "
jektex : false
layout : post
---

سيؤدي تعيين علامة jektex إلى true أو لا يؤدي على الإطلاق إلى تعبيرات Jektex لتقديم تعبيرات اللاتكس في هذا المنشور.

باستخدام وحدات الماكرو
يمكنك تحديد وحدات الماكرو العالمية:

 jektex :
  macros :
    - ["\Q", "\mathbb{Q}"]
    - ["\C", "\mathbb{C}"]

ونعم ، عليك الهروب من رد الفعل العكسي ( ) مع رد فعل عنيف آخر. هذا بسبب مواصفات YAML.

يمكنك تحديد الماكرو مع المعلمات:

 jektex :
  macros :
    - ["\vec", "\mathbf{#1}"]
    - ["\addBar", "\bar{#1}"]

هذا يحاكي سلوك اللاتكس newcommand .

إسكات الإخراج jektex
تقوم Jektex بإبلاغ المستخدم بشكل دوري بالمعادلات المقدمة/المخزنة مؤقتًا. إذا لم يكن هذا مطلوبًا ، فيمكنك تعيين الخيار silent ( false افتراضيًا).

 jektex :
  silent : true

أمثلة كاملة
التكوين الموصى به:

 jektex :
  cache_dir : " .jektex-cache "
  ignore : ["*.xml"]
  silent : false
  macros :
    - ["\Q", "\mathbb{Q}"]
    - ["\C", "\mathbb{C}"]

عدم وجود تكوين يعادل هذا:

 jektex :
  cache_dir : " .jekyll-cache "
  ignore : []
  silent : false
  macros : [] 

تثبيت

هذا البرنامج المساعد متاح باعتباره Rubygem.

باستخدام bundler
أضف Jektex إلى Gemfile الخاص بك:

 group :jekyll_plugins do
    gem "jektex"
end

وتركيب bundle install التثبيت

بدون حظر
تشغيل gem install jektex

بعد التثبيت
أضف Jektex إلى قائمة البرنامج المساعد الخاص بك في ملف _config.yml الخاص بك

 plugins :
    - jektex

ولا تنس إضافة katex.min.css لك HTML Head:

 < link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css " integrity =" sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ " crossorigin =" anonymous " >

من الأفضل تنزيل ملف CSS وتحميله كأصل من الخادم الخاص بك مباشرة. يمكنك العثور على مزيد من المعلومات على موقع Katex.

المساهمات وتقارير الأخطاء

لا تتردد في الإبلاغ عن أي أخطاء أو حتى تقديم طلب ميزة في القضايا المتعلقة بالمستودع الرسمي. أنا فتحت لطلبات السحب كذلك.