Skip to content

Commit e405d64

Browse files
committed
Document the new GitLab option in README.md
1 parent 6cc269c commit e405d64

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,16 @@ The single-dollar delimiter (`$...$`) for inline math is disabled by
8989
default, but can be enabled by passing `enable_dollar_delimiter=True`
9090
in the extension configuration.
9191

92+
If you want to use [GitLab-style delimiters] (``$`...`$`` for inline math,
93+
and a code block-like `` ```math...``` `` syntax for standalone), use
94+
`use_gitlab_delimiters=True` configuration option.
95+
9296
If you want to this extension to generate a preview node (which will be shown
9397
when MathJax has not yet processed the node, or when JavaScript is unavailable),
9498
use `add_preview=True` configuration option.
9599

100+
[GitLab-style delimiters]: https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md#math
101+
96102
Notes
97103
-----
98104

@@ -104,5 +110,5 @@ This extension also works with Katex. Use the following in your page `<head>`:
104110
```html
105111
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css" crossorigin="anonymous">
106112
<script src="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.js" crossorigin="anonymous"></script>
107-
<script src="https://cdn.jsdelivr.net/npm/katex/dist/contrib/mathtex-script-type.min.js" defer></script>
113+
<script src="https://cdn.jsdelivr.net/npm/katex/dist/contrib/mathtex-script-type.min.js" defer></script>
108114
```

0 commit comments

Comments
 (0)