jektex
jektex 0.1.1
Plugin Jekyll untuk rendering lateks yang di-side server menyala-cepat, dengan dukungan untuk makro. Nikmati kenyamanan lateks dan penurunan harga tanpa mengacaukan situs Anda dengan javascript yang membengkak. Proyek ini didukung oleh Katex.org.
Jektex mendukung notasi matematika Kramdown bawaan, dan notasi matematika lateks yang lebih baru.
Formula inline
Masukkan formula antara dua pasang tanda dolar ( $$ ) di dalam paragraf.
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. Formula tampilan
Letakkan formula di antara dua pasang tanda dolar ( $$ ) dan mengelilingi dengan dua garis kosong.
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. Mengapa JekTex tidak menggunakan $ tunggal konvensional untuk rumus inline dan $$ ganda untuk mode tampilan?
Beginilah cara kerja Kramdown (Jekyll's Markdown Parser) jadi saya memutuskan untuk menghormati konvensi ini. Itu membuat plugin ini lebih konsisten dan universal. Lihat masalah ini untuk konteks lebih lanjut.
Formula inline
Letakkan formula di antara dua braket yang melarikan diri ( ) . Posisinya dalam teks tidak masalah.
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. Formula tampilan
Letakkan formula di antara dua braket persegi yang diloloskan [ ] . Posisinya dalam teks tidak masalah.
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. Ada build di makro untuk logo Jektex. Anda dapat menggunakannya sebagai jektex .
Jektex Si sangat dapat dikonfigurasi melalui file _config.yml Anda.
Menonaktifkan cache
Anda dapat menonaktifkan caching dengan disable_disk_cache = true in _config.yml . Caching diaktifkan secara default. Anda dapat menemukan informasi lebih lanjut di situs web resmi Jekyll.
Mengatur lokasi cache
Secara default, Jektex Cache akan disimpan di direktori .jekyll-cache . Ini menghasilkan penghapusannya saat Anda menyebut jekyll clean . Untuk mencegah penghapusan cache atau mengubah lokasi cache, Anda dapat menentukan cache_dir di _config.yml :
jektex :
cache_dir : " .jektex-cache " Mengabaikan file
Secara default, Jektex mencoba membuat lateks di semua file yang diberikan oleh Jekyll. Kadang -kadang ini bisa tidak diinginkan, misalnya ketika merenderkan umpan RSS dengan kutipan yang mengandung lateks. Jektex memecahkan ini dengan menggunakan opsi ignore :
jektex :
ignore : ["*.xml", "README.md", "_drafts/*" ] Anda dapat menggunakan kartu liar konvensional menggunakan * . Contoh konfigurasi ini mengabaikan semua file .xml , README.md dan semua file di direktori _drafts .
Cara lain untuk mengabaikan posting tertentu adalah dengan mengatur atribut jektex di depan materi ke false :
---
title : " How Jektex works "
category : " Development "
jektex : false
layout : post
--- Mengatur tag jektex ke true atau tidak pengaturan sama sekali akan menghasilkan ekspresi lateks rendering jektex di posting itu.
Menggunakan makro
Anda dapat mendefinisikan makro global:
jektex :
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"] Dan ya, Anda harus melarikan diri dari reaksi ( ) dengan reaksi lain. Ini karena spesifikasi YAML.
Anda dapat mendefinisikan makro dengan parameter:
jektex :
macros :
- ["\vec", "\mathbf{#1}"]
- ["\addBar", "\bar{#1}"] Ini mensimulasikan perilaku Latex newcommand .
Membungkam output jektex
Jektex secara berkala memberi tahu pengguna tentang persamaan yang diberikan/di -cache. Jika ini tidak diinginkan, Anda dapat mengatur opsi silent ( false secara default).
jektex :
silent : true Contoh lengkap
Konfigurasi yang Disarankan:
jektex :
cache_dir : " .jektex-cache "
ignore : ["*.xml"]
silent : false
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"]Tidak memiliki konfigurasi setara dengan ini:
jektex :
cache_dir : " .jekyll-cache "
ignore : []
silent : false
macros : [] Plugin ini tersedia sebagai rubygem.
Menggunakan bundler
Tambahkan Jektex ke Gemfile Anda:
group :jekyll_plugins do
gem "jektex"
end dan jalankan bundle install
Tanpa bundler
Jalankan gem install jektex
Setelah instalasi
Tambahkan JekTex ke daftar plugin Anda di file _config.yml Anda
plugins :
- jektex Dan jangan lupa untuk menambahkan katex.min.css ke kepala html Anda:
< link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css " integrity =" sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ " crossorigin =" anonymous " >Ini adalah praktik yang jauh lebih baik untuk mengunduh file CSS dan memuatnya sebagai aset dari server Anda secara langsung. Anda dapat menemukan informasi lebih lanjut di situs web Katex.
Jangan ragu untuk melaporkan bug apa pun atau bahkan membuat permintaan fitur dalam masalah repositori resmi. Saya juga dibuka untuk permintaan tarik.
