Skip to content

feat(plugin-typedoc): Add setup callback for TypeDoc customization#2841

Merged
SoonIter merged 3 commits intoweb-infra-dev:mainfrom
Karibash:feature/typedoc
Dec 8, 2025
Merged

feat(plugin-typedoc): Add setup callback for TypeDoc customization#2841
SoonIter merged 3 commits intoweb-infra-dev:mainfrom
Karibash:feature/typedoc

Conversation

@Karibash
Copy link
Copy Markdown
Contributor

@Karibash Karibash commented Dec 3, 2025 •
edited
Loading

Summary

This PR adds a new setup option to the @rspress/plugin-typedoc plugin, allowing users to customize the TypeDoc Application before document generation.

Example

pluginTypeDoc({
  entryPoints: ['./src/index.ts'],
  setup: (app) => {
    app.setOptions({
      categoryOrder: ['Core', 'Utils'],
    });
  },
});

Related Issue

close #2642

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 3, 2025 14:26
@netlify
Copy link
Copy Markdown

netlify bot commented Dec 3, 2025 •
edited
Loading

✅ Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit 2dd98ca
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/693629f81cae4c0008e79df7
😎 Deploy Preview https://deploy-preview-2841--rspress-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI reviewed Dec 3, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

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 a new setup callback option to the TypeDoc plugin, allowing users to customize the TypeDoc Application before documentation generation. This addresses issue #2642 by providing a hook for advanced TypeDoc configuration.

Key changes:

  • Added a new optional setup callback parameter to the PluginTypeDocOptions interface
  • The callback is invoked after TypeDoc Application bootstrapping but before document conversion
  • Documentation added in both English and Chinese for the new configuration option

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
packages/plugin-typedoc/src/index.ts Added setup callback parameter to the plugin interface and implementation to allow TypeDoc Application customization
website/docs/en/plugin/official-plugins/typedoc.mdx Added English documentation for the new setup configuration option
website/docs/zh/plugin/official-plugins/typedoc.mdx Added Chinese documentation for the new setup configuration option

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

SoonIter
SoonIter reviewed Dec 4, 2025
View reviewed changes
@Karibash
feat(plugin-typedoc): Add setup callback for TypeDoc customization
602b53c 
# Conflicts:
#	packages/plugin-typedoc/src/index.ts
@SoonIter
Copy link
Copy Markdown
Member

SoonIter commented Dec 8, 2025

thanks ❤️️

@SoonIter SoonIter enabled auto-merge (squash) December 8, 2025 07:38
@SoonIter SoonIter merged commit 7710bfe into web-infra-dev:main Dec 8, 2025
9 checks passed
@Karibash Karibash deleted the feature/typedoc branch December 8, 2025 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@SoonIter SoonIter SoonIter approved these changes

Assignees

No one assigned

Labels

change: feat

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature]: Enhanced typedoc configuration

3 participants

@Karibash @SoonIter