jektex
jektex 0.1.1
Ein Jekyll-Plugin für das renne laderische Rendering von Server-Side-Side-Seite mit Unterstützung für Makros. Genießen Sie den Komfort von Latex und Markdown, ohne Ihre Website mit aufgeblähtem JavaScript zu überfüllen. Dieses Projekt wird von katex.org unterstützt.
JeKtex unterstützt sowohl die eingebaute Kramdown-Mathematiknotation als auch die neuere Mathematik-Notation mit Latex.
Inline -Formel
Setzen Sie die Formel zwischen zwei Dollar -Schildern ( $$ ) in den Absatz.
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. Formel anzeigen
Setzen Sie die Formel zwischen zwei Dollar -Schildern ( $$ ) und umgeben Sie sie mit zwei leeren Linien.
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. Warum verwendet JeKtex keine konventionellen Single $ für Inline -Formeln und Double $$ für den Anzeigemodus?
So funktioniert Kramdown (Jekylls Markdown -Parser), daher habe ich beschlossen, diese Konvention zu respektieren. Es macht dieses Plugin konsistenter und universeller. Weitere Kontext finden Sie in diesem Thema.
Inline -Formel
Setzen Sie die Formel zwischen zwei entkommenen Klammern ( ) . Seine Position im Text spielt keine Rolle.
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. Formel anzeigen
Setzen Sie die Formel zwischen zwei entkommenen Quadratklammern [ ] . Seine Position im Text spielt keine Rolle.
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. Es gibt einen Build in Makro für das Jektex -Logo. Sie können es als jektex verwenden.
JeKtex SI ist über Ihre Datei _config.yml hoch konfigurierbar.
Cache deaktivieren
Sie können das Caching mit disable_disk_cache = true in _config.yml deaktivieren. Das Caching ist standardmäßig aktiviert. Weitere Informationen finden Sie auf der offiziellen Website von Jekyll.
Cache -Standort einstellen
Standardmäßig wird JeKtex Cache im Verzeichnis .jekyll-cache gespeichert. Dies führt zu seiner Löschung, wenn Sie jekyll clean nennen. Um die Cache -Löschung zu verhindern oder den Cache -Speicherort zu ändern, können Sie cache_dir in _config.yml angeben:
jektex :
cache_dir : " .jektex-cache " Dateien ignorieren
Standardmäßig versucht JeKtex, in allen von Jekyll verwendeten Dateien Latex zu rendern. Dies kann manchmal unerwünscht sein, beispielsweise bei der Rendern eines RSS -Feeds mit Latexauszügen. JeKtex löst dies mit der Option ignore :
jektex :
ignore : ["*.xml", "README.md", "_drafts/*" ] Sie können herkömmliche Wildkarten mit * verwenden. Diese Beispielkonfiguration ignoriert alle .xml -Dateien, README.md und alle Dateien im Verzeichnis _drafts .
Eine andere Möglichkeit, bestimmte Beiträge zu ignorieren, besteht darin, das jektex -Attribut vor Front Materie auf false festzulegen:
---
title : " How Jektex works "
category : " Development "
jektex : false
layout : post
--- Das Setzen von jektex -Tag in true or nicht zu einer Einstellung führt dazu, dass Jektex in diesem Beitrag Latex -Ausdrücke ausdrückt.
Verwenden von Makros
Sie können globale Makros definieren:
jektex :
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"] Und ja, Sie müssen der Gegenreaktion ( ) mit einer weiteren Gegenreaktion entkommen. Dies liegt an der YAML -Spezifikation.
Sie können Makros mit Parametern definieren:
jektex :
macros :
- ["\vec", "\mathbf{#1}"]
- ["\addBar", "\bar{#1}"] Dies simuliert das Verhalten von Latex newcommand .
Stummschaltung von JEKTEX Output
JeKtex informiert den Benutzer regelmäßig über gerenderte/zwischengespeicherte Gleichungen. Wenn dies nicht erwünscht ist, können Sie die silent Option festlegen (standardmäßig false ).
jektex :
silent : true Vollständige Beispiele
Empfohlene Konfiguration:
jektex :
cache_dir : " .jektex-cache "
ignore : ["*.xml"]
silent : false
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"]Eine Konfiguration entspricht dieser Frage:
jektex :
cache_dir : " .jekyll-cache "
ignore : []
silent : false
macros : [] Dieses Plugin ist als Rubygem erhältlich.
Mit Bundler
Fügen Sie Ihre Gemfile hinzu:
group :jekyll_plugins do
gem "jektex"
end und bundle install
Ohne Bundler
Rennen Sie gem install jektex
Nach der Installation
Fügen Sie Ihre Plugin -Liste in Ihrer _config.yml -Datei zu Ihrer Plugin -Liste hinzu
plugins :
- jektex Und vergessen Sie nicht, Ihnen den HTML -Kopf katex.min.css hinzuzufügen:
< link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css " integrity =" sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ " crossorigin =" anonymous " >Es ist viel besser, die CSS -Datei herunterzuladen und sie direkt von Ihrem Server von Ihrem Server zu laden. Weitere Informationen finden Sie auf der Website von Katex.
Fühlen Sie sich frei, Fehler zu melden oder sogar Feature -Anfrage in Problemen im offiziellen Repository zu stellen. Ich bin auch für Pull -Anfragen geöffnet.
