-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for
packages
entry point strategy
- Loading branch information
Showing
27 changed files
with
311 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
import starlight from '@astrojs/starlight' | ||
import { defineConfig } from 'astro/config' | ||
import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc' | ||
|
||
export default defineConfig({ | ||
base: '/packages-entrypoints/', | ||
integrations: [ | ||
starlight({ | ||
plugins: [ | ||
starlightTypeDoc({ | ||
entryPoints: ['../fixtures/packages/packages/*'], | ||
output: 'api-packages-entrypoints', | ||
tsconfig: '../fixtures/packages/tsconfig.json', | ||
typeDoc: { | ||
entryPointStrategy: 'packages', | ||
}, | ||
}), | ||
], | ||
sidebar: [ | ||
{ | ||
label: 'Guides', | ||
items: [{ label: 'Example Guide', link: '/guides/example/' }], | ||
}, | ||
typeDocSidebarGroup, | ||
], | ||
title: 'Starlight TypeDoc Packages Entry Points Example', | ||
}), | ||
], | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
# Autogenerated by https://github.com/HiDeoo/starlight-typedoc | ||
api/ | ||
api-multiple-entrypoints/ | ||
api-packages-entrypoints/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"name": "@starlight-typedoc/fixtures-packages", | ||
"version": "0.0.1", | ||
"license": "MIT", | ||
"description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.", | ||
"author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)", | ||
"type": "module", | ||
"scripts": { | ||
"build": "tsc --build" | ||
}, | ||
"dependencies": { | ||
"typescript": "5.1.6" | ||
}, | ||
"engines": { | ||
"node": ">=18.14.1" | ||
}, | ||
"packageManager": "pnpm@8.6.1", | ||
"private": true, | ||
"sideEffects": false, | ||
"keywords": [ | ||
"starlight", | ||
"plugin", | ||
"typedoc", | ||
"typescript", | ||
"documentation", | ||
"astro" | ||
], | ||
"homepage": "https://github.com/HiDeoo/starlight-typedoc", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/HiDeoo/starlight-typedoc.git" | ||
}, | ||
"bugs": "https://github.com/HiDeoo/starlight-typedoc/issues" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"name": "bar", | ||
"version": "0.0.1", | ||
"license": "MIT", | ||
"description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.", | ||
"author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)", | ||
"type": "module", | ||
"packageManager": "pnpm@8.6.1", | ||
"private": true, | ||
"sideEffects": false, | ||
"keywords": [ | ||
"starlight", | ||
"plugin", | ||
"typedoc", | ||
"typescript", | ||
"documentation", | ||
"astro" | ||
], | ||
"homepage": "https://github.com/HiDeoo/starlight-typedoc", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/HiDeoo/starlight-typedoc.git" | ||
}, | ||
"bugs": "https://github.com/HiDeoo/starlight-typedoc/issues" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** | ||
* A function that does a bar thing. | ||
*/ | ||
export function doBar() { | ||
return 'doBar' | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from './functions.js' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"extends": "../../tsconfig.base.json", | ||
"compilerOptions": { | ||
"rootDir": "src", | ||
"outDir": "dist" | ||
}, | ||
"include": ["src"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"entryPoints": ["src/index.ts"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"name": "foo", | ||
"version": "0.0.1", | ||
"license": "MIT", | ||
"description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.", | ||
"author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)", | ||
"type": "module", | ||
"packageManager": "pnpm@8.6.1", | ||
"private": true, | ||
"sideEffects": false, | ||
"keywords": [ | ||
"starlight", | ||
"plugin", | ||
"typedoc", | ||
"typescript", | ||
"documentation", | ||
"astro" | ||
], | ||
"homepage": "https://github.com/HiDeoo/starlight-typedoc", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/HiDeoo/starlight-typedoc.git" | ||
}, | ||
"bugs": "https://github.com/HiDeoo/starlight-typedoc/issues" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
/** | ||
* A function that does a foo thing. | ||
* @deprecated Use the new {@link doFooFaster} function instead. | ||
*/ | ||
export function doFoo() { | ||
return 'doFoo' | ||
} | ||
|
||
/** | ||
* A function that does another foo thing but faster. | ||
* | ||
* This is a faster alternative to {@link doFoo}. | ||
*/ | ||
export function doFooFaster() { | ||
return 'doFoo' | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from './functions.js' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"extends": "../../tsconfig.base.json", | ||
"compilerOptions": { | ||
"rootDir": "src", | ||
"outDir": "dist" | ||
}, | ||
"include": ["src"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"entryPoints": ["src/index.ts"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"compilerOptions": { | ||
"composite": true, | ||
"declaration": true, | ||
"declarationMap": true, | ||
"module": "NodeNext", | ||
"strict": true | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"files": [], | ||
"references": [ | ||
{ | ||
"path": "./packages/bar" | ||
}, | ||
{ | ||
"path": "./packages/foo" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...tarlight-typedoc/tests/e2e/asides.test.ts → ...t-typedoc/tests/e2e/basics/asides.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...arlight-typedoc/tests/e2e/content.test.ts → ...-typedoc/tests/e2e/basics/content.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ight-typedoc/tests/e2e/pagination.test.ts → ...pedoc/tests/e2e/basics/pagination.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...arlight-typedoc/tests/e2e/sidebar.test.ts → ...-typedoc/tests/e2e/basics/sidebar.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.