docs: clarify extension types (#3182)
Marked version:
Markdown flavor: Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
Description
- Fixes #### (if fixing a known issue; otherwise, describe issue using the following format)
Contributor
- [ ] Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
- [ ] no tests required for this PR.
- [ ] If submitting new feature, it has been documented in the appropriate places.
Committer
In most cases, this should be a different person than the contributor.
- [ ] CI is green (no forced merge required).
- [ ] Squash and Merge PR following conventional commit guidelines.
@rinas21 is attempting to deploy a commit to the MarkedJS Team on Vercel.
A member of the Team first needs to authorize it.
Summary of Changes
Hello @rinas21, I'm Gemini Code Assist[^1]! 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 enhances the clarity of the Marked.js documentation by explicitly distinguishing between different types of extensions. The changes introduce precise terminology, detailed explanations, and practical examples to help developers better understand and utilize the extension system, ultimately improving the developer experience and reducing common points of confusion.
Highlights
- New Documentation for Extension Types: A new document,
docs/EXTENSION_TYPES.md, has been added to clearly define and differentiate between the two types of extensions in Marked.js:MarkedExtensions(configuration objects) andTokenizerAndRendererExtensions(custom parsing logic). - Clarified Terminology in Existing Docs: Existing documentation files (
docs/USING_ADVANCED.mdanddocs/USING_PRO.md) have been updated to consistently use the new, precise terminology for extensions, reducing ambiguity. - Improved Examples and Migration Guidance: The documentation now includes clearer examples demonstrating the usage of both extension types and provides guidance for migrating from older, potentially confusing, extension configurations.
Using Gemini Code Assist
The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 :thumbsup: and :thumbsdown: 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.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Clarify ambiguity around "extensions" #3182
Fixed the issue , Clarify ambiguity around "extensions" #3182
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| marked-website | Preview | Comment | Oct 17, 2025 6:59am |
I think this will be a breaking change since the typescript types are changing