Merge pull request #325 from Mathpix/dev/olga/Add-the-ability-to-disa…

…ble-Markdown-rules PR into master from dev/olga/Add-the-ability-to-disable-Markdown-rules
Mathpix · May 15, 2024 · edf6433 · edf6433
2 parents 1982fae + 9a56b31
commit edf6433
Show file tree

Hide file tree

Showing 53 changed files with 4,776 additions and 88 deletions.
diff --git a/README.md b/README.md
@@ -762,6 +762,7 @@ The `MathpixMarkdown` React element accepts the following props:
 | `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                                 |
 | `copyToClipboard` | boolean;*`false`*            | Added copy to clipboard button for code chunks. To handle events, import the function addListenerCopyToClipdoardEvents() from "mathpix-markdown-it/lib/copy-to-clipboard";|
+| `renderOptions`  | [RenderOptions](https://github.com/Mathpix/mathpix-markdown-it#renderoptions);*`{}`*   | Sets options to enable render rules                          |
 
 ### optionsMathpixMarkdown
 
@@ -794,6 +795,7 @@ The `MathpixMarkdown` React element accepts the following props:
 | `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                                 |
 | `copyToClipboard` | boolean;*`false`*            | Added copy to clipboard button for code chunks. To handle events, import the function addListenerCopyToClipdoardEvents() from "mathpix-markdown-it/lib/copy-to-clipboard";|
+| `renderOptions`  | [RenderOptions](https://github.com/Mathpix/mathpix-markdown-it#renderoptions);*`{}`*   | Sets options to enable render rules                             |
 
 ### TOutputMath
 
@@ -875,6 +877,14 @@ The `MathpixMarkdown` React element accepts the following props:
 |----------------|-----------------------------|-------------------------------------------|
 | `fontSize`     | string&nbsp;*`unset`*       | Ability to change font size for footnotes |
 
+### RenderOptions
+
+|                                   | type&nbsp;*`default`*                                                                          |                                                                                                                                                              |
+|-----------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `enable_markdown`                 | boolean&nbsp;*`true`*                                                                          | Enable markdown rules. If it is set to `false`, then all markdown rules will be disabled. This also disables the rules for `enable_markdown_mmd_extensions`. |
+| `enable_latex`                    | boolean&nbsp;*`true`*                                                                          | Enable latex rules. If it is set to `false`, then all latex and math rules will be disabled.                                                                 |
+| `enable_markdown_mmd_extensions`  | boolean&nbsp;*`true`*                                                                          | Enable markdown mmd extensions rules: `smiles`, `asciiMath`, `mathML`. If it is set to `false` then these rules will be disabled.                            |
+
 ### TAccessibility
 
 |                             | type&nbsp;*`default`*       | description

diff --git a/es5/bundle.js b/es5/bundle.js
diff --git a/es5/index.js b/es5/index.js
diff --git a/lib/components/mathpix-markdown/index.js b/lib/components/mathpix-markdown/index.js
diff --git a/lib/components/mathpix-markdown/index.js.map b/lib/components/mathpix-markdown/index.js.map
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -2,11 +2,11 @@ import MathpixLoader from './components/mathpix-loader';
 import MathpixMarkdown from './components/mathpix-markdown';
 import { mathpixMarkdownPlugin, initMathpixMarkdown } from './markdown/mathpix-markdown-plugins';
 import { mdPluginMathJax, mdPluginHighlightCode, mdPluginText, mdPluginTOC, mdPluginAnchor, mdPluginTableTabular, mdPluginList, mdPluginChemistry, mdPluginCollapsible, mdLatexFootnotes, mdSetPositionsAndHighlight } from "./markdown/mdPluginConfigured";
-import { MathpixMarkdownModel, TMarkdownItOptions, optionsMathpixMarkdown, TOutputMath, TOutputMathJax, THtmlSanitize, TTocStyle, THighlight, ParserErrors, CodeHighlight, Footnotes } from "./mathpix-markdown-model";
+import { MathpixMarkdownModel, TMarkdownItOptions, optionsMathpixMarkdown, TOutputMath, TOutputMathJax, THtmlSanitize, TTocStyle, THighlight, ParserErrors, CodeHighlight, Footnotes, RenderOptions } from "./mathpix-markdown-model";
 import { ISmilesOptions } from './markdown/md-chemistry';
 import { resetTheoremEnvironments } from './markdown/md-theorem/helper';
 import { rest_mmd_footnotes_list } from './markdown/md-latex-footnotes/utils';
 import { FootnoteItem } from './markdown/md-latex-footnotes/interfaces';
 import { eLabelType, ILabel, getLabelsList, getLabelByKeyFromLabelsList, clearLabelsList } from "./markdown/common/labels";
 import { normalizeLink } from './helpers/normalize-link';
-export { MathpixLoader, MathpixMarkdown, MathpixMarkdownModel, mathpixMarkdownPlugin, mdPluginCollapsible, mdLatexFootnotes, mdSetPositionsAndHighlight, initMathpixMarkdown, mdPluginMathJax, mdPluginHighlightCode, mdPluginText, mdPluginTOC, mdPluginAnchor, mdPluginTableTabular, mdPluginList, mdPluginChemistry, TMarkdownItOptions, optionsMathpixMarkdown, TOutputMath, TOutputMathJax, THtmlSanitize, ISmilesOptions, resetTheoremEnvironments, rest_mmd_footnotes_list, FootnoteItem, TTocStyle, THighlight, CodeHighlight, ParserErrors, Footnotes, eLabelType, ILabel, getLabelsList, getLabelByKeyFromLabelsList, clearLabelsList, normalizeLink };
+export { MathpixLoader, MathpixMarkdown, MathpixMarkdownModel, mathpixMarkdownPlugin, mdPluginCollapsible, mdLatexFootnotes, mdSetPositionsAndHighlight, initMathpixMarkdown, mdPluginMathJax, mdPluginHighlightCode, mdPluginText, mdPluginTOC, mdPluginAnchor, mdPluginTableTabular, mdPluginList, mdPluginChemistry, TMarkdownItOptions, optionsMathpixMarkdown, TOutputMath, TOutputMathJax, THtmlSanitize, ISmilesOptions, resetTheoremEnvironments, rest_mmd_footnotes_list, FootnoteItem, TTocStyle, THighlight, CodeHighlight, ParserErrors, Footnotes, eLabelType, ILabel, getLabelsList, getLabelByKeyFromLabelsList, clearLabelsList, normalizeLink, RenderOptions };
diff --git a/lib/index.js.map b/lib/index.js.map
diff --git a/lib/markdown/common/consts.d.ts b/lib/markdown/common/consts.d.ts
@@ -1,3 +1,4 @@
+import { RenderOptions } from "../../mathpix-markdown-model";
 export declare const attr_value: string;
 export declare const attribute: string;
 export declare const openTagMML: RegExp;
@@ -127,3 +128,4 @@ export declare const codeHighlightDef: {
     auto: boolean;
     code: boolean;
 };
+export declare const renderOptionsDef: RenderOptions;