docs: clarify extension terminology ambiguity#3881
docs: clarify extension terminology ambiguity#3881njg7194 wants to merge 1 commit intomarkedjs:masterfrom
Conversation
Add a terminology note section to explain the difference between: - MarkedExtension: the configuration object passed to marked.use() - TokenizerAndRendererExtension: custom syntax definitions in the extensions array This addresses the confusion described in markedjs#3182 where 'extensions' is used with two different meanings throughout the documentation. Fixes markedjs#3182
|
Someone is attempting to deploy a commit to the MarkedJS Team on Vercel. A member of the Team first needs to authorize it. |
Summary of ChangesHello @njg7194, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the clarity of the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful 'Terminology Note' to the documentation to clarify the difference between 'Marked Extension' and 'Custom Extension'. The explanation is clear and the code example is illustrative. I've added a couple of minor suggestions to include the walkTokens extension point for even greater completeness. Overall, this is a valuable improvement to the documentation.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
UziTech
left a comment
UziTech
left a comment
There was a problem hiding this comment.
Thank you 💯
Hopefully that will clear up some of the documentation issues.
2 participants
Summary
This PR addresses the confusion around the "extensions" terminology as described in #3182.
Changes
Added a Terminology Note section at the beginning of the USING_PRO.md documentation that clearly distinguishes between:
MarkedExtensionmarked.use()TokenizerAndRendererExtensionextensionsarray for custom syntaxAlso included a code example showing the relationship between these two concepts.
Related Issue
Fixes #3182
Checklist