jektex
jektex 0.1.1
Плагин Jekyll для латексного рендеринга на стороне сервера с поддержкой макросов. Наслаждайтесь комфортом латекса и отметки, не загромождая свой сайт раздутым JavaScript. Этот проект одобрен katex.org.
Jektex поддерживает как встроенную нотацию по математике Kramdown, так и более новую математическую нотацию только латекс.
Встроенная формула
Поместите формулу между двумя парами знаков доллара ( $$ ) внутри абзаца.
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 $$ для режима отображения?
Вот как работает Крамдаун (Парсер Джекилла), поэтому я решил уважать эту конвенцию. Это делает этот плагин более последовательным и универсальным. Смотрите эту проблему для большего контекста.
Встроенная формула
Поместите формулу между двумя сбежавшими кронштейнами ( ) . Его положение в тексте не имеет значения.
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. Вы можете использовать его как jektex .
Jektex si сильно настраивается через ваш файл _config.yml .
Отключение кеша
Вы можете отключить кэширование с disable_disk_cache = true in _config.yml . Кэширование включено по умолчанию. Вы можете найти больше информации на официальном веб -сайте Jekyll.
Установка расположения кэша
По умолчанию кэш Jektex будет сохранен в каталоге .jekyll-cache . Это приводит к его удалению, когда вы называете jekyll clean . Чтобы предотвратить удаление кэша или изменить местоположение кэша, вы можете указать cache_dir в _config.yml :
jektex :
cache_dir : " .jektex-cache " Игнорирование файлов
По умолчанию Jektex пытается отображать латекс во всех файлах, отображаемых Jekyll. Иногда это может быть нежелательным, например, при рендеринге RSS -канала с отрывками, содержащими латекс. 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}"] Это имитирует поведение LaTex 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.
Используя бундлер
Добавьте 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.
Не стесняйтесь сообщать о любых ошибках или даже делать запрос на функции в вопросах официального репозитория. Я также открыт для запросов на привлечение.
