Skip to content

Commit e85d64a

Browse files
tgreyuktgreyuk
committed
feat(docusaurus): decouple typedoc logic into dedicated "typedoc-docusaurus-theme" plugin
1 parent 05f3b32 commit e85d64a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+1155
-931
lines changed

‎.github/workflows/ci.typedoc-docusaurus-theme.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: CI [typedoc-docusaurus-theme]
2+
on:
3+
push:
4+
paths:
5+
- 'packages/typedoc-docusaurus-theme/**'
6+
- '!packages/typedoc-docusaurus-theme/README.md'
7+
- '!packages/typedoc-docusaurus-theme/CHANGELOG.md'
8+
- '!packages/typedoc-docusaurus-theme/package.json'
9+
branches:
10+
- main
11+
- release
12+
- beta
13+
pull_request:
14+
paths:
15+
- 'packages/typedoc-docusaurus-theme/**'
16+
- '!packages/typedoc-docusaurus-theme/README.md'
17+
- '!packages/typedoc-docusaurus-theme/CHANGELOG.md'
18+
- '!packages/typedoc-docusaurus-theme/package.json'
19+
jobs:
20+
lint-and-test:
21+
runs-on: ubuntu-latest
22+
strategy:
23+
matrix:
24+
node: ['18']
25+
name: Node ${{ matrix.node }}
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v3
29+
- name: Set up Node
30+
uses: actions/setup-node@v3
31+
with:
32+
node-version: ${{ matrix.node }}
33+
cache: 'npm'
34+
- name: Install
35+
run: HUSKY=0 npm install
36+
- name: Lint
37+
run: npm run lint --workspace typedoc-docusaurus-theme
38+
- name: Build
39+
run: npm run build --workspace typedoc-plugin-markdown --workspace typedoc-docusaurus-theme
40+
- name: Test
41+
run: npm run test --workspace typedoc-docusaurus-theme

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Please see [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org).
1616
[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-github-wiki-theme?label=↓) | [Changelog](./packages/typedoc-github-wiki-theme/CHANGELOG.md) |
1717
[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-gitlab-wiki-theme?label=↓) | [Changelog](./packages/typedoc-gitlab-wiki-theme/CHANGELOG.md) |
1818
[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-vitepress-theme?label=↓) | [Changelog](./packages/typedoc-vitepress-theme/CHANGELOG.md) |
19+
[typedoc-docusaurus-theme](./packages/typedoc-docusaurus-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-docusaurus-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-docusaurus-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-docusaurus-theme?label=↓) | [Changelog](./packages/typedoc-docusaurus-theme/CHANGELOG.md) |
1920
[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | ![Downloads](https://img.shields.io/npm/dw/docusaurus-plugin-typedoc?label=↓) | [Changelog](./packages/docusaurus-plugin-typedoc/CHANGELOG.md) |
2021

2122
## Contributing

‎devtools/examples/docusaurus-ts/docusaurus.config.ts‎

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +45,28 @@ const config: Config = {
4545
[
4646
docusaurusPlugin,
4747
{
48-
...require(
49-
path.join(
50-
__dirname,
51-
'../../../packages/typedoc-plugin-markdown/test/fixtures/typedoc.cjs',
52-
),
53-
),
54-
tsconfig: path.join(
55-
__dirname,
56-
'../../../packages/typedoc-plugin-markdown/test/fixtures/tsconfig.json',
57-
),
58-
entryPoints: [
59-
'../../../packages/typedoc-plugin-markdown/test/fixtures/src/reflections/index.ts',
60-
],
48+
tsconfig: './stubs/tsconfig.json',
49+
entryPoints: ['./stubs/src/index.ts'],
50+
readme: 'none',
51+
cleanOutputDir: true,
52+
logLevel: 'Warn',
53+
},
54+
],
55+
[
56+
docusaurusPlugin,
57+
{
58+
id: 'api-2',
59+
tsconfig: './stubs/tsconfig.json',
60+
entryPoints: ['./stubs/src/index.ts'],
61+
out: './docs/api-2',
62+
readme: 'none',
6163
sidebar: {
6264
typescript: true,
6365
pretty: true,
66+
deprecatedItemClassName: 'is-deprecated',
6467
},
68+
logLevel: 'Warn',
69+
plugin: ['./stubs/custom-plugin.mjs'],
6570
},
6671
],
6772
],
@@ -114,6 +119,12 @@ const config: Config = {
114119
label: 'API 1',
115120
position: 'left',
116121
},
122+
{
123+
to: 'docs/api-2',
124+
activeBasePath: 'docs',
125+
label: 'API 2',
126+
position: 'left',
127+
},
117128
],
118129
},
119130
footer: {

‎devtools/examples/docusaurus-ts/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"scripts": {
66
"docusaurus": "docusaurus",
77
"prestart": "rm -rf ./docs && cd ../../../packages/docusaurus-plugin-typedoc && npm run build",
8+
"generate": "npm run prestart && docusaurus generate-typedoc",
89
"start": "docusaurus start",
910
"build": "docusaurus build",
1011
"swizzle": "docusaurus swizzle",

‎devtools/examples/docusaurus-ts/sidebars.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { SidebarsConfig } from '@docusaurus/plugin-content-docs';
2-
import typedocSidebar from './docs/api/typedoc-sidebar';
1+
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
2+
import typedocSidebar from './docs/api-2/typedoc-sidebar';
33

44
const sidebars: SidebarsConfig = {
55
typedocSidebar: [
@@ -8,7 +8,7 @@ const sidebars: SidebarsConfig = {
88
label: 'Typedoc API',
99
link: {
1010
type: 'doc',
11-
id: 'api/index',
11+
id: 'api-2/index',
1212
},
1313
items: typedocSidebar.items,
1414
},

‎devtools/examples/docusaurus-ts/stubs/custom-plugin.mjs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// @ts-check
2+
import * as fs from 'fs';
3+
import { MarkdownRendererEvent } from 'typedoc-plugin-markdown';
4+
5+
export function load(app) {
6+
app.renderer.on(MarkdownRendererEvent.END, (renderer) => {
7+
fs.writeFileSync(
8+
`${renderer.outputDirectory}/custom-plugin.txt`,
9+
'custom-plugin',
10+
);
11+
});
12+
}

‎packages/docusaurus-plugin-typedoc/test/stubs/src/links.ts‎ renamed to ‎devtools/examples/docusaurus-ts/stubs/src/index.ts‎

File renamed without changes.

‎packages/docusaurus-plugin-typedoc/test/stubs/tsconfig.json‎ renamed to ‎devtools/examples/docusaurus-ts/stubs/tsconfig.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
"strict": true,
99
"noUnusedLocals": false,
1010
"noUnusedParameters": false,
11-
"target": "es2022"
11+
"target": "es2022",
12+
"jsx": "react",
13+
"types": ["node", "react"]
1214
},
1315
"include": ["./src/*.ts"]
1416
}

‎devtools/packages/helpers/constants.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,15 @@ export const DOCS_CONFIG: Record<string, DocsConfig> = {
5151
declarations: true,
5252
presets: true,
5353
},
54-
['docusaurus-plugin-typedoc']: {
54+
['typedoc-docusaurus-theme']: {
5555
declarationsPath: `${process.cwd()}/src/options/declarations.ts`,
5656
presetsPath: `${process.cwd()}/src/options/presets.ts`,
57-
optionsPath: '/plugins/docusaurus',
57+
optionsPath: 'plugins/docusaurus',
5858
docsPath: '/plugins/docusaurus',
5959
declarations: true,
6060
presets: true,
6161
},
62+
['docusaurus-plugin-typedoc']: {
63+
docsPath: '/plugins/docusaurus',
64+
},
6265
};

‎devtools/packages/helpers/models.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ export interface DocsConfig {
22
declarationsPath?: string;
33
translatablePath?: string;
44
presetsPath?: string;
5-
optionsPath: string;
5+
optionsPath?: string;
66
optionsFile?: string;
77
docsPath: string;
8-
declarations: boolean;
9-
presets: boolean;
8+
declarations?: boolean;
9+
presets?: boolean;
1010
categories?: Record<string, string>;
1111
}
1212

0 commit comments

Comments
 (0)