diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /plugins/mathjax/README.md | |
parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'plugins/mathjax/README.md')
-rw-r--r-- | plugins/mathjax/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md new file mode 100644 index 00000000..43d07c93 --- /dev/null +++ b/plugins/mathjax/README.md @@ -0,0 +1,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.7.20 +``` |