feat!: use diplodoc/latex-extension instead of markdown-it-katex #184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview is ready. |
smsochneg
approved these changes
Feb 6, 2024
- added packages to peerDependencies: `@diplodoc/latex-extension`, `katex`, `markdown-it`
- editor's Math extension now use `@diplodoc/latex-extension` instead of `markdown-it-katex`
- Math extension removed from YfmPreset/YfmSpecsPreset
- added options to Math extension
Example of using a Math extension:
```js
import {Math} from '@doc-tools/yfm-editor/_/extensions/yfm/Math';
// ...
builder.use(Math, {
// required
loadRuntimeScript: async () => {
await Promise.all([
import('@diplodoc/latex-extension/runtime'),
import('@diplodoc/latex-extension/runtime/styles'),
]);
},
// optional; if you need custom sanitizing
sanitize: (html) => /* sanitize html */ html,
// optional; options to be passed to katex
katexOptions: {},
});
```
d3m1d0v
force-pushed
the
diplodoc-latex-extension
branch
from
1b7f439 to
ee2237a
Compare
makhnatkin
pushed a commit
that referenced
this pull request
May 28, 2024
- added packages to peerDependencies: `@diplodoc/latex-extension`, `katex`, `markdown-it`
- editor's Math extension now use `@diplodoc/latex-extension` instead of `markdown-it-katex`
- Math extension removed from YfmPreset/YfmSpecsPreset and package root export
- added options to Math extension
Example of using a Math extension:
```js
import {Math} from '@doc-tools/yfm-editor/_/extensions/yfm/Math';
// ...
builder.use(Math, {
// required
loadRuntimeScript: async () => {
await Promise.all([
import('@diplodoc/latex-extension/runtime'),
import('@diplodoc/latex-extension/runtime/styles'),
]);
},
// optional; if you need custom sanitizing
sanitize: (html) => /* sanitize html */ html,
// optional; options to be passed to katex
katexOptions: {},
});
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@diplodoc/latex-extension,katex,markdown-it@diplodoc/latex-extensioninstead ofmarkdown-it-katexExample of using a Math extension: