A docsify.js plugin for typesetting LaTeX with display engines from markdown
npm install docsify-latex
A docsify.js plugin for typesetting LaTeX with display engines from markdown.
Docsify + LaTeX = :heart:
Add JavaScript LaTeX display engine, and docsify-latex plugin after docsify and engine scirpts all to your index.html.
For example, I prefer [MathJax][MathJax], and load scripts from the content delivery network (CDN):
``html`
Configure latex plugin options:
`javascript`
window.$docsify = {
// ...
latex: {
inlineMath : [['$', '$'], ['\\(', '\\)']], // default
displayMath : [['$$', '$$']], // default
}
};
> Notice:
>
> You should put docsify-latex plugin script below docsify and LaTeX display engine scripts, because plugin script depends on them.
>
> To keep loading scripts in order, you also should remove async attribute from the script element.
See [Documentation site][Documentation] for more usage and more details.
Put LaTeX within symbols you configured.
For example, by default we configured $$ for marking section inner LaTeX in display mode, then:
`math``
$$
E=mc^2
$$
Go to display engine official website for more details about supported LaTeX functions.
See [Documentation site][Documentation] for more usage and more details.
Seeking for demo projects, click [here][Demo Projects] to learn more.
This plugin helps you typeset LaTeX with some JavaScript LaTeX display engines.
Supported engine features:
- Equation cross-reference jump (same page only)
- Typsetting complex LaTeX content
- Overflowed content scroll bar
See [Documentation Example][Documentation Example] for more details.
List of integrated engines:
- MathJax V3
- MathJax V2
- KaTeX
> If you want to integrate more engines, feel free to fire an issue to explain the reason, or more well, you can directly make a pull request.
This project is licensed under the MIT License.
See the LICENSE for details.
Copyright (c) Scruel Tao (@scruel)
[MathJax]: https://docs.mathjax.org
[Documentation]: https://scruel.github.io/docsify-latex
[Documentation Example]: https://scruel.github.io/docsify-latex/#/example
[Demo Projects]: https://scruel.github.io/docsify-latex/#/demo