Skip to content

Conversation

Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from Copilot June 4, 2025 09:04
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds JSDoc comments throughout the plugin-markdown-ext source and polishes both Chinese and English documentation for the plugin, including a minor update to copilot instruction formatting.

  • Added JSDoc blocks to options.ts, markdownExtPlugin.ts, vPre.ts, utils.ts, and component.ts to improve inline API documentation.
  • Refined wording and list formatting in Chinese (docs/zh/plugins/markdown/markdown-ext.md) and English (docs/plugins/markdown/markdown-ext.md) docs for consistency.
  • Updated guidance in .github/copilot-instructions.md for when to use inline vs. paragraph descriptions.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
plugins/markdown/plugin-markdown-ext/src/node/options.ts Added JSDoc for the MarkdownExtPluginOptions interface.
plugins/markdown/plugin-markdown-ext/src/node/markdownExtPlugin.ts Added JSDoc for the markdownExtPlugin export.
plugins/markdown/plugin-markdown-ext/src/node/markdown-it-plugins/vPre.ts Added JSDoc for the vPre plugin.
plugins/markdown/plugin-markdown-ext/src/node/markdown-it-plugins/utils.ts Added JSDoc for the stringifyProp utility.
plugins/markdown/plugin-markdown-ext/src/node/markdown-it-plugins/component.ts Added JSDoc around the component fence plugin.
docs/zh/plugins/markdown/markdown-ext.md Improved Chinese phrasing and formatting.
docs/plugins/markdown/markdown-ext.md Improved English phrasing and formatting.
.github/copilot-instructions.md Clarified guideline for inline vs. paragraph details.
Comments suppressed due to low confidence (4)

docs/zh/plugins/markdown/markdown-ext.md:143

  • The footnote section is missing its default value. Please include a - 默认值:false`` bullet per documentation standards.
- 详情:是否启用脚注格式支持。

docs/zh/plugins/markdown/markdown-ext.md:170

  • The tasklist section omits the default value. Add - 默认值:false`` to maintain consistency.
  是否启用任务列表格式支持。你可以传递一个对象来配置任务列表。

docs/plugins/markdown/markdown-ext.md:143

  • The footnote section should include - Default: false`` before the details bullet to align with the docs convention.
- Details: Whether to enable footnote format support.

docs/plugins/markdown/markdown-ext.md:169

  • The tasklist section is missing its - Default: false`` entry; please add it to match the plugin docs format.
    Whether to enable tasklist format support. You can pass an object to config tasklist.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 15438227050

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 59.517%

Totals Coverage Status
Change from base Build 15437986461: 0.0%
Covered Lines: 1358
Relevant Lines: 2058

💛 - Coveralls

@Mister-Hope Mister-Hope merged commit a42fac4 into main Jun 4, 2025
30 checks passed
@Mister-Hope Mister-Hope deleted the markdown-ext-refine branch June 4, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants