refactor(plugin-markdown-include): add jsdoc for markdownIncludePlugi…

[Mister-Hope]

No description provided.

[Copilot]

Pull Request Overview

This PR adds JSDoc comments for the markdown-include plugin and refines both Chinese and English documentation for clearer wording and correct region markers.

• Add JSDoc to options.ts to document plugin options.
• Add JSDoc to markdownIncludePlugin.ts with @param and example usage.
• Update Chinese and English docs to improve wording, fix region annotations, and correct the deep option description.

Reviewed Changes

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

File	Description
plugins/markdown/plugin-markdown-include/src/node/options.ts	Add JSDoc comments for plugin options
plugins/markdown/plugin-markdown-include/src/node/markdownIncludePlugin.ts	Add JSDoc comments for the plugin factory and example
docs/zh/plugins/markdown/markdown-include.md	Polish Chinese docs: wording, region markers, options
docs/plugins/markdown/markdown-include.md	Polish English docs: wording, region markers, options

Comments suppressed due to low confidence (2)

docs/plugins/markdown/markdown-include.md:343

• [nitpick] The description has a minor grammatical issue. Consider revising to something like Whether to recursively include files referenced in included Markdown files.

Details: Whether deep include files in included Markdown files.

plugins/markdown/plugin-markdown-include/src/node/markdownIncludePlugin.ts:14

• [nitpick] The JSDoc is missing a @returns tag. Consider adding @returns - VuePress plugin instance to document the return value of this factory function.

* @param options - Plugin options / 插件选项

[coveralls]

Pull Request Test Coverage Report for Build 15439240529

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

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
Change from base Build 15438799930:	0.0%
Covered Lines:	1358
Relevant Lines:	2058

---

💛 - Coveralls