blob: 985b975d0ec8b58ae3f01f6cc7487a1adadd3067 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
# MathJax plugin
[MathJax](https://docs.mathjax.org/) allows you to include mathematics in your web pages. The `mathjax` Dokka plugin
adds the ability to render mathematics found in source code comments.
If MathJax plugin encounters the `@usesMathJax` KDoc tag, it adds `MathJax.js` (ver. 2) with `config=TeX-AMS_SVG`
to the generated HTML pages.
Usage example:
```kotlin
/**
* Some math \(\sqrt{3x-1}+(1+x)^2\)
*
* @usesMathJax
*/
class Foo {}
```
Note that the `@usesMathJax` tag is case-sensitive.
The MathJax plugin is published to Maven Central as a
[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/mathjax-plugin):
```text
org.jetbrains.dokka:mathjax-plugin:1.8.20
```
|
