Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 3.31 KB

README.md

File metadata and controls

97 lines (66 loc) · 3.31 KB
Raw

docsify-latex

License: MIT GitHub Workflow Status (master) NPM jsDelivr

A docsify.js plugin for typesetting LaTeX with display engines from markdown.


Docsify + LaTeX = ❤️

Installation

Add JavaScript LaTeX display engine, and docsify-latex plugin after docsify and engine scirpts all to your index.html.

For example, I prefer MathJax, and load scripts from the content delivery network (CDN):

<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<!-- LaTeX display engine -->
<script src="//cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<!--  docsify-latex plugin -->
<script src="//cdn.jsdelivr.net/npm/docsify-latex@0"></script>

Configure latex plugin options:

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 for more usage and more details.

Usage

Put LaTeX within symbols you configured.

For example, by default we configured $$ for marking section inner LaTeX in display mode, then:

$$ E=mc^2 $$

Go to display engine official website for more details about supported LaTeX functions.

See Documentation site for more usage and more details.

Seeking for demo projects, click here to learn more.

Features

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 for more details.

List of integrated engines:

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.

License

This project is licensed under the MIT License.

See the LICENSE for details.

Copyright (c) Scruel Tao (@scruel)