Skip to content

fix(plugin-typedoc): allow typedoc plugin interface as usual #2836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Timeless0911 merged 3 commits into from
Dec 4, 2025
Merged

fix(plugin-typedoc): allow typedoc plugin interface as usual #2836

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0123e45
fix(plugin-typedoc): allow typedoc plugin interface as usual
SoonIter Dec 3, 2025
cfebb6f
Update packages/plugin-typedoc/src/index.ts
SoonIter Dec 3, 2025
9bf4599
fix(plugin-typedoc): normalize Windows paths before calculating relat…
Copilot Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions e2e/fixtures/plugin-typedoc/multi/rspress.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ export default defineConfig({
plugins: [
pluginTypeDoc({
entryPoints: [
'./src/index.ts',
'./src/middleware.ts',
'./src/raw-link.ts',
path.join(__dirname, './src/index.ts'),
path.join(__dirname, './src/middleware.ts'),
path.join(__dirname, './src/raw-link.ts'),
],
}),
],
Expand Down
2 changes: 1 addition & 1 deletion e2e/fixtures/plugin-typedoc/single/rspress.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default defineConfig({
root: path.join(__dirname, 'doc'),
plugins: [
pluginTypeDoc({
entryPoints: ['./src/index.ts'],
entryPoints: [path.join(__dirname, './src/index.ts')],
}),
],
});
11 changes: 10 additions & 1 deletion packages/plugin-typedoc/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import path from 'node:path';
import { cwd } from 'node:process';
import type { RspressPlugin } from '@rspress/core';
import { Application } from 'typedoc';
import { load as loadPluginMarkdown } from 'typedoc-plugin-markdown';
Expand All @@ -19,7 +20,15 @@ export interface PluginTypeDocOptions {
}

export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
const { entryPoints = [], outDir = API_DIR } = options;
const { entryPoints: userEntryPoints = [], outDir = API_DIR } = options;

// windows posix path fix https://github.com/web-infra-dev/rspress/pull/2790#issuecomment-3590946652
const entryPoints = userEntryPoints.map(entryPath => {
return path.isAbsolute(entryPath)
? path.posix.relative(entryPath, cwd())
: entryPath;
});

return {
name: '@rspress/plugin-typedoc',
async config(config) {
Expand Down
Loading