https://github.com/scruel/docsify-latex

A docsify.js plugin for typesetting LaTeX with display engines from markdown.
https://github.com/scruel/docsify-latex

docsify docsify-latex katex latex math mathjax

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/scruel/docsify-latex
• Owner: scruel
• License: mit
• Created: 2022-09-19T01:45:27.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T02:14:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T02:33:15.443Z (2 months ago)
• Topics: docsify, docsify-latex, katex, latex, math, mathjax
• Language: JavaScript
• Homepage: https://scruel.github.io/docsify-latex
• Size: 1.1 MB
• Stars: 28
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docsify-latex

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/scruel/docsify-latex/blob/master/LICENSE)

[![GitHub Workflow Status (master)](https://img.shields.io/github/actions/workflow/status/scruel/docsify-latex/build.yml?branch=master&label=checks&style=flat-square)](https://github.com/scruel/docsify-latex/actions?query=branch%3Amaster+)

[![NPM](https://img.shields.io/npm/v/docsify-latex.svg?style=flat-square)](https://www.npmjs.com/package/docsify-latex)

[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/docsify-latex/badge)](https://www.jsdelivr.com/package/npm/docsify-latex)

A [docsify.js](https://docsify.js.org) plugin for typesetting LaTeX with display engines from markdown.




Docsify + LaTeX = :heart:


## 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][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.

## Usage

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.

## 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][Documentation Example] for more details.

**List of integrated engines**:

- [MathJax V3](https://docs.mathjax.org/)

- [MathJax V2](https://docs.mathjax.org/en/v2.7-latest/index.html)

- [KaTeX](https://katex.org/docs)

> 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](https://github.com/scruel/docsify-latex/blob/master/LICENSE) for details.

Copyright (c) Scruel Tao ([@scruel](https://github.com/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