jektex
jektex 0.1.1
Um plug-in Jekyll para renderização de látex em cache do servidor ardente, com suporte para macros. Aproveite o conforto do látex e do Markdown sem atrapalhar seu site com JavaScript inchado. Este projeto é endossado por katex.org.
A Jektex suporta a notação matemática interna de Kramdown e a mais recente notação matemática somente para látex.
Fórmula embutida
Coloque a fórmula entre dois pares de sinais de dólar ( $$ ) dentro do parágrafo.
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. Exibir fórmula
Coloque a fórmula entre dois pares de sinais de dólar ( $$ ) e rodeie -a com duas linhas vazias.
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 que o JEKTEX não usa um único $ para fórmulas embutidas e $$ duplo para o modo de exibição?
Foi assim que o Kramdown (o analisador de Jekyll's Markdown) funciona, então decidi respeitar esta convenção. Isso torna este plugin mais consistente e universal. Veja esta questão para obter mais contexto.
Fórmula embutida
Coloque a fórmula entre dois colchetes escapados ( ) . Sua posição no texto não 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. Exibir fórmula
Coloque a fórmula entre dois colchetes escapados [ ] . Sua posição no texto não 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. Há uma construção no Macro para o logotipo JEKTEX. Você pode usá -lo como jektex .
Jektex Si altamente configurável através do seu arquivo _config.yml .
Desativar o cache
Você pode desativar o cache com disable_disk_cache = true em _config.yml . O cache é ativado por padrão. Você pode encontrar mais informações sobre o site oficial de Jekyll.
Definir localização do cache
Por padrão, o Jektex Cache será salvo no diretório .jekyll-cache . Isso resulta em sua exclusão quando você chama jekyll clean . Para evitar a exclusão de cache ou alterar o local do cache, você pode especificar cache_dir em _config.yml :
jektex :
cache_dir : " .jektex-cache " Ignorando arquivos
Por padrão, Jektex tenta renderizar o LATEX em todos os arquivos renderizados por Jekyll. Às vezes, isso pode ser indesejável, por exemplo, ao renderizar um feed RSS com trechos contendo látex. Jektex resolve isso usando a opção ignore :
jektex :
ignore : ["*.xml", "README.md", "_drafts/*" ] Você pode usar curingas convencionais usando * . Este exemplo de configuração ignora todos os arquivos .xml , README.md e todos os arquivos no diretório _drafts .
Outra maneira de ignorar postagens específicas é definir o atributo jektex no assunto da frente como false :
---
title : " How Jektex works "
category : " Development "
jektex : false
layout : post
--- Definir a tag jektex como true ou não, a configuração resultará em Jektex renderizando expressões de látex nessa postagem.
Usando macros
Você pode definir macros globais:
jektex :
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"] E sim, você tem que escapar da reação ( ) com outra reação. Isso se deve à especificação YAML.
Você pode definir macros com parâmetros:
jektex :
macros :
- ["\vec", "\mathbf{#1}"]
- ["\addBar", "\bar{#1}"] Isso simula o comportamento do látex newcommand .
Silenciando a saída JEKTEX
Jektex informa periodicamente ao usuário sobre equações renderizadas/em cache. Se isso não for desejado, você pode definir a opção silent ( false por padrão).
jektex :
silent : true Exemplos completos
Config recomendado:
jektex :
cache_dir : " .jektex-cache "
ignore : ["*.xml"]
silent : false
macros :
- ["\Q", "\mathbb{Q}"]
- ["\C", "\mathbb{C}"]Não ter configuração é equivalente a isso:
jektex :
cache_dir : " .jekyll-cache "
ignore : []
silent : false
macros : [] Este plug -in está disponível como um rubygem.
Usando Bundler
Adicione Jektex ao seu Gemfile :
group :jekyll_plugins do
gem "jektex"
end e executar bundle install
Sem Bundler
Execute gem install jektex
Após a instalação
Adicione Jektex à sua lista de plug -in no seu arquivo _config.yml
plugins :
- jektex E não se esqueça de adicionar katex.min.css a sua cabeça html:
< link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css " integrity =" sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ " crossorigin =" anonymous " >É uma prática muito melhor baixar o arquivo CSS e carregá -lo como um ativo diretamente do seu servidor. Você pode encontrar mais informações no site da Katex.
Sinta -se à vontade para relatar quaisquer bugs ou mesmo fazer solicitação de recurso em questões no repositório oficial. Também estou aberto para solicitações de tração.
