diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /plugins/mathjax/README.md | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2 dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip | |
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing
* Update Gradle to 8.4
* Refactor and simplify convention plugins and build scripts
Fixes #3132
---------
Co-authored-by: Adam <897017+aSemy@users.noreply.github.com>
Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'plugins/mathjax/README.md')
| -rw-r--r-- | plugins/mathjax/README.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md deleted file mode 100644 index a12095ee..00000000 --- a/plugins/mathjax/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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.9.10 -``` |