mathpix-markdown-it 1.2.11 → 1.2.13

package/README.md

@@ -60,7 +60,7 @@ OC(=O)c1cc(Cl)cs1
 
 - [theorems and proofs](doc/theorems.md)
 
-```text
+```tex
 \newtheorem{theorem}{Theorem}
 \newtheorem{lemma}[theorem]{Lemma}
 
@@ -84,7 +84,7 @@ proceed from there and at some point you will arrive to a contradiction.
 
 - [Latex footnotes](doc/latex-footnotes.md)
 
-```text
+```tex
 Footnote marker without text. Auto increment counter to 1 \footnotemark{} should be 1.
 
 Footnote marker with text. Auto increment counter to 2 \footnotemark{} be 2. \footnotetext{text should be 2}
@@ -104,6 +104,26 @@ Auto increment counter to 8 \footnote{text  should be 8}
 
 ![](doc/images/latex-footnotes/latex-footnotes_01.png)
 
+- [Latex underline](doc/latex-underline.md)
+
+```tex
+Underline text: \underline{Underlined text!}
+Underline text: \uline{Underlined text!}
+
+Double underline text: \underline{\underline{Double underlined text!}}
+Double underline text: \uuline{Double underlined text!}
+
+Wavy underlined text: \uwave{This text is underlined with a wavy line!}
+
+Dashed underline text: \dashuline{Dashed Underline}
+Dotted underline text: \dotuline{Dotted Underline}
+
+Strikethrough text: \sout{Text with a horizontal line through its center!}
+Struck with Hatching text: \xout{Text with hatching pattern!}
+```
+
+![](doc/images/latex-underline/latex-underline_07.png)
+
 # What is mathpix-markdown-it? 
 
 **mathpix-markdown-it** is an open source implementation of the mathpix-markdown spec written in Typescript.
@@ -690,6 +710,7 @@ The `MathpixMarkdown` React element accepts the following props:
 | `smiles`         | [ISmilesOptions](https://github.com/Mathpix/mathpix-markdown-it#ismilesoptions);*`{}`*        | Sets options to output chemistry equation                                                                              |
 | `parserErrors`   | [ParserErrors](https://github.com/Mathpix/mathpix-markdown-it#parsererrors);*`{}`*        | Sets options to output parser errors for equations and tabular                    |
 | `codeHighlight`  | [CodeHighlight](https://github.com/Mathpix/mathpix-markdown-it#codehighlight);*`{}`*      | Sets options to highlight code block                      |
+| `footnotes`      | [Footnotes](https://github.com/Mathpix/mathpix-markdown-it#footnotes);*`{}`*              | Sets options to footnotes                                 |
 
 
 ## MathpixMarkdownModel methods
@@ -739,6 +760,7 @@ The `MathpixMarkdown` React element accepts the following props:
 | `enableCodeBlockRuleForLatexCommands`| boolean;*`false`* | By default, if latex commands are indented (4 spaces / 1 tab) they do not become `Code Blocks`.               |
 | `parserErrors`   | [ParserErrors](https://github.com/Mathpix/mathpix-markdown-it#parsererrors);*`{}`*        | Sets options to output parser errors for equations and tabular                    |
 | `codeHighlight`  | [CodeHighlight](https://github.com/Mathpix/mathpix-markdown-it#codehighlight);*`{}`*      | Sets options to highlight code block                      |
+| `footnotes`      | [Footnotes](https://github.com/Mathpix/mathpix-markdown-it#footnotes);*`{}`*              | Sets options to footnotes                                 |
 
 ### optionsMathpixMarkdown
 
@@ -769,6 +791,7 @@ The `MathpixMarkdown` React element accepts the following props:
 | `enableCodeBlockRuleForLatexCommands`| boolean;*`false`* | By default, if latex commands are indented (4 spaces / 1 tab) they do not become `Code Blocks`.               |
 | `parserErrors`   | [ParserErrors](https://github.com/Mathpix/mathpix-markdown-it#parsererrors);*`{}`*        | Sets options to output parser errors for equations and tabular                    |
 | `codeHighlight`  | [CodeHighlight](https://github.com/Mathpix/mathpix-markdown-it#codehighlight);*`{}`*      | Sets options to highlight code block                      |
+| `footnotes`      | [Footnotes](https://github.com/Mathpix/mathpix-markdown-it#footnotes);*`{}`*              | Sets options to footnotes                                 |
 
 ### TOutputMath
 
@@ -829,16 +852,6 @@ The `MathpixMarkdown` React element accepts the following props:
 | `includeStyles`             | boolean *`false`*      | Includes mathpix-markdown styles                                                                                                            |
 | `includeFonts`              | boolean *`false`*      | Includes mathpix-markdown fonts                                                                                                             |
 
-
-### TAccessibility
-
-|                             | type *`default`*       | description
-|-----------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-| `assistiveMml`              | boolean *`false`*      | Should Assistive MathML be enabled to math (mjx-container).                                                                                |
-| `sre`                       | object *`null`*        | spe object from library [speech-rule-engine](https://www.npmjs.com/package/speech-rule-engine) for semantic interpretation.                                                                    |
-|                             |                             | If this value is not set then the aria-label for accessibility will not be added to the math at render time.                               |  
-
-
 ### ParserErrors enum
 
 |              |                                         |
@@ -854,8 +867,21 @@ The `MathpixMarkdown` React element accepts the following props:
 | `auto`       | boolean *`false`* | Highlighting with language detection                                                                          |
 | `code`       | boolean *`true`*  | Add code highlighting for a code block which created by indenting. To auto-detect the language, set auto=true |
 
-`sre` Has different loaders for node and browser.
+### Footnotes
+
+|                | type *`default`*       |                                           |
+|----------------|-----------------------------|-------------------------------------------|
+| `fontSize`     | string *`unset`*       | Ability to change font size for footnotes |
+
+### TAccessibility
 
+|                             | type *`default`*       | description
+|-----------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| `assistiveMml`              | boolean *`false`*      | Should Assistive MathML be enabled to math (mjx-container).                                                                                |
+| `sre`                       | object *`null`*        | spe object from library [speech-rule-engine](https://www.npmjs.com/package/speech-rule-engine) for semantic interpretation.                                                                    |
+|                             |                             | If this value is not set then the aria-label for accessibility will not be added to the math at render time.                               |  
+
+`sre` Has different loaders for node and browser.
 1. For **Browser libraries**, synchronous loading is used.
 ```js
 import { loadSre } from "mathpix-markdown-it/lib/sre/sre-browser";

package/doc/latex-footnotes.md

@@ -58,3 +58,18 @@ footnote\footnotetext{Specifically, I'd write comments in this one.}.
 This example produces the following output:
 
 ![](images/latex-footnotes/latex-footnotes_03.png)
+
+
+## Example: using `\blfootnotetext`
+
+The `\blfootnotemark` command allows to add footnotes without a marker
+
+```tex
+The footnote \footnote{Footnote with marker}
+
+\blfootnotetext{Footnote without marker}
+```
+
+This example produces the following output:
+
+![](images/latex-footnotes/latex-footnotes_04.png)

package/doc/latex-underline.md

@@ -0,0 +1,83 @@
+## Underline, bold and italize text
+
+We can print bold, italicized, and underlined text using the commands `\textbf`, `\textit`, and `\underline`, respectively. 
+
+For example:
+```
+\textbf{Bold text} 
+\textit{Italic text}
+\underline{Underlined text}
+```
+
+This example produces the following output:
+
+![](images/latex-underline/latex-underline_01.png)
+
+
+## Double underline
+
+Double underlining text can be done easily using the command `\underline` twice or using the command `\uuline`:
+
+```
+\underline{\underline{Double underlined text!}}
+
+\uuline{Double underlined text!}
+```
+
+produces the output:
+
+![](images/latex-underline/latex-underline_02.png)
+
+
+## Wavy underlined text
+
+We can easily create wavy underlined text using the command `\uwave{}`. Here is an illustrative example:
+
+```
+\uwave{This text is underlined with a wavy line!}
+```
+
+which produces the following result:
+
+![](images/latex-underline/latex-underline_03.png)
+
+
+## Strikethrough text
+
+The command `\sout{}` which can be used to strikethrough text. Check this example:
+
+```
+\sout{Text with a horizontal line through its center!}
+```
+
+compiling this code yields:
+
+![](images/latex-underline/latex-underline_04.png)
+
+
+## Slash through letter
+
+The command `\xout{}` can be used to create a hatching effect through text. Here is a basic usage of this command:
+
+```
+\xout{Text with hatching pattern!}
+```
+
+This code yields the following:
+
+![](images/latex-underline/latex-underline_05.png)
+
+
+## Dashed and dotted underline
+
+The commands `\dashuline{}` and `\dotuline{}` as their names state can be used to create dashed and dotted lines under text respectively. Check the following code:
+
+```
+\dashuline{Dashed Underline}
+
+\dotuline{Dotted Underline}
+```
+
+which produces the following output:
+
+![](images/latex-underline/latex-underline_06.png)