jektex
jektex 0.1.1
Un complemento de Jekyll para la representación de látex en caché del servidor del servidor blazing, con soporte para macros. Disfrute de la comodidad del látex y el markdown sin abarrotar su sitio con JavaScript hinchado. Este proyecto está respaldado por Katex.org.
Jektex admite tanto la notación matemática de Kramdown incorporada como la nueva notación matemática de solo látex.
Fórmula en línea
Ponga la fórmula entre dos pares de signos de dólar ( $$ ) dentro del párrafo.
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. Fórmula de visualización
Coloque la fórmula entre dos pares de signos de dólar ( $$ ) y llévelo con dos líneas vacías.
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. ¿Por qué Jektex no usa $ Single $ para fórmulas en línea y $$ doble para el modo de visualización?
Así es como funciona Kramdown (Jekyll's Markdown Parser), así que decidí respetar esta convención. Hace que este complemento sea más consistente y universal. Vea este problema para más contexto.
Fórmula en línea
Poner fórmula entre dos soportes escapados ( ) . Su posición en el texto no importa.
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. Fórmula de visualización
Ponga fórmula entre dos soportes cuadrados escapados [ ] . Su posición en el texto no importa.
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. Hay una construcción en la macro para el logotipo de Jektex. Puedes usarlo como jektex .
Jektex SI altamente configurable a través de su archivo _config.yml .
Desactivando el caché
Puede deshabilitar el almacenamiento en caché con disable_disk_cache = true en _config.yml . El almacenamiento en caché está habilitado de forma predeterminada. Puede encontrar más información sobre el sitio web oficial de Jekyll.
Configuración de la ubicación de caché
Por defecto, Jektex Cache se guardará en el directorio .jekyll-cache . Esto da como resultado su eliminación cuando llamas jekyll clean . Para evitar la eliminación de caché o para cambiar la ubicación de caché, puede especificar cache_dir en _config.yml :
jektex :
cache_dir : " .jektex-cache " Ignorando archivos
Por defecto, Jektex intenta renderizar látex en todos los archivos renderizados por Jekyll. Esto a veces puede ser indeseable, por ejemplo, al hacer una alimentación RSS con extractos que contienen látex. Jektex resuelve esto usando la opción ignore :
jektex :
ignore : ["*.xml", "README.md", "_drafts/*" ] Puedes usar comodines convencionales usando * . Esta configuración de ejemplo ignora todos los archivos .xml , README.md y todos los archivos en el directorio _drafts .
Otra forma de ignorar publicaciones específicas es establecer el atributo jektex en la parte delantera en false :
---
title : " How Jektex works "
category : " Development "
jektex : false
layout : post
--- Establecer la etiqueta jektex en true o no configurar en absoluto dará como resultado que Jektex represente expresiones de látex en esa publicación.
Usando macros
Puede definir macros globales:
jektex :
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"] Y sí, tienes que escapar de la reacción ( ) con otra reacción. Esto se debe a la especificación YAML.
Puede definir macros con parámetros:
jektex :
macros :
- ["\vec", "\mathbf{#1}"]
- ["\addBar", "\bar{#1}"] Esto simula el comportamiento del látex newcommand .
Silenciando la salida de Jektex
Jektex informa periódicamente al usuario sobre las ecuaciones renderizadas/en caché. Si esto no se desea, puede establecer la opción silent ( false de forma predeterminada).
jektex :
silent : true Ejemplos completos
Configuración recomendada:
jektex :
cache_dir : " .jektex-cache "
ignore : ["*.xml"]
silent : false
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"]No tener configuración es equivalente a esto:
jektex :
cache_dir : " .jekyll-cache "
ignore : []
silent : false
macros : [] Este complemento está disponible como Rubygem.
Usando Bundler
Agregue Jektex a su Gemfile :
group :jekyll_plugins do
gem "jektex"
end y ejecutar bundle install
Sin Bundler
Ejecutar gem install jektex
Después de la instalación
Agregue Jektex a su lista de complementos en su archivo _config.yml
plugins :
- jektex Y no olvides agregar katex.min.css a tu cabeza html:
< link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css " integrity =" sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ " crossorigin =" anonymous " >Es una práctica mucho mejor descargar el archivo CSS y cargarlo como un activo desde su servidor directamente. Puede encontrar más información sobre el sitio web de Katex.
No dude en informar cualquier error o incluso hacer una solicitud de función en problemas en el repositorio oficial. También estoy abierto para solicitudes de extracción.
