[DOCS] Tweaks to docs to make them clearer, regarding hooks and options to lexer/parser #2946
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
UziTech
reviewed
Aug 16, 2023
docs/USING_PRO.md
Outdated
| @@ -615,7 +611,7 @@ The parser takes tokens as input and calls the renderer functions. | |||
|
|
|||
| <h2 id="extend">Access to Lexer and Parser</h2> | |||
|
|
|||
| You also have direct access to the lexer and parser if you so desire. | |||
| You also have direct access to the lexer and parser if you so desire. The `options` parameter is the same options that `marked.use` takes, documented [here](/using_advanced#options). | |||
There was a problem hiding this comment.
It actually isn't the same as what marked.use accepts. marked.use accepts most options but some are different. For example, renderer doesn't need to extend marked.Renderer, it can just be an object (as explained in the bottom of https://marked.js.org/using_pro#use).
The lexer and parser options are the same as passed to marked.setOptions() except they have to be full options objects, they don't get merged with the current or default options.
There was a problem hiding this comment.
Thanks for the updated explanation, I've tried to fix the docs accordingly.
UziTech
approved these changes
Aug 16, 2023
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.
Marked version:
HEAD
Markdown flavor: n/a
Description
Contributor
Committer
In most cases, this should be a different person than the contributor.