Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 712 Bytes

README.md

File metadata and controls

27 lines (20 loc) · 712 Bytes

MathJax plugin

MathJax 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:

/**
 * 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:

org.jetbrains.dokka:mathjax-plugin:2.0.0