Skip to content

Update extend parser documentation #1834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
patacra wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update extend parser documentation #1834

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
694516d
Update extend-parser.md to remove the old hooks no longer existant
patacra Jun 10, 2025
c96a313
Did a mistake: wrong hook name.
patacra Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/extend-parser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,25 @@ Run `Markdown Preview Enhanced: Extend Parser (Global)` or `Markdown Preview Enh

```javascript
({
/**
* Hook to modify the Markdown code before it is parsed.
*
* @param {String} markdown The original Markdown code.
* @returns {String} The modified Markdown code.
*/
onWillParseMarkdown: async function(markdown) {
return markdown;
},

/**
* Hook to modify the HTML output of the parser.
*
* @param {String} html The HTML code returned by the parser.
* @returns {String} The modified HTML code.
*/
onDidParseMarkdown: async function(html) {
return html;
},

onWillTransformMarkdown: async function(markdown) {
return markdown;
},

onDidTransformMarkdown: async function(markdown) {
return markdown;
},
});
```

Expand Down