Skip to content

Commit 79dd69e

Browse files
committed
feat(docs): Add remark plugins to API docs
1 parent 50a8d25 commit 79dd69e

File tree

7 files changed

+104
-34
lines changed

7 files changed

+104
-34
lines changed

.pnp.cjs

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
204 KB
Binary file not shown.

.yarn/patches/docusaurus-plugin-typedoc-api-npm-3.0.1-7dd061feb2.patch

Lines changed: 89 additions & 22 deletions
Large diffs are not rendered by default.

packages/docusaurus/docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ const config = {
114114
typedocOptions: {
115115
plugin: [`./src/typedoc/plugin.ts`],
116116
},
117+
remarkPlugins,
117118
},
118119
],
119120
],

packages/docusaurus/src/remark/autoLink.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import visit from 'unist-util-visit-parents';
1+
import visit from 'unist-util-visit-parents';
2+
import {pathToFileURL} from 'url';
23

34
export type AutoLinkSpec = {
45
sourceType: `json-schema`;
@@ -88,7 +89,7 @@ export const plugin = (userSpecs: Array<AutoLinkSpec>) => () => {
8889
if (hasAutoLinks) {
8990
ast.children.unshift({
9091
type: `import`,
91-
value: `import {AutoLink} from '@yarnpkg/docusaurus/src/components/AutoLink';\n`,
92+
value: `import {AutoLink} from ${JSON.stringify(pathToFileURL(require.resolve(`../components/CommandLineHighlight.tsx`)))};\n`,
9293
});
9394
}
9495
};

packages/docusaurus/src/remark/commandLineHighlight.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {parseShell} from '@yarnpkg/parsers';
33
import {Definition, Token} from 'clipanion';
44
import {capitalize} from 'lodash';
55
import visit from 'unist-util-visit-parents';
6+
import {pathToFileURL} from 'url';
67

78
export type ScriptLine =
89
| RawLine
@@ -178,7 +179,7 @@ export const plugin = () => () => {
178179
if (highlightNodes.length > 0) {
179180
ast.children.unshift({
180181
type: `import`,
181-
value: `import {CommandLineHighlight} from '@yarnpkg/docusaurus/src/components/CommandLineHighlight';\n`,
182+
value: `import {CommandLineHighlight} from ${JSON.stringify(pathToFileURL(require.resolve(`../components/CommandLineHighlight.tsx`)))};\n`,
182183
});
183184

184185
await Promise.all(highlightNodes);

yarn.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8472,7 +8472,7 @@ __metadata:
84728472

84738473
"docusaurus-plugin-typedoc-api@patch:docusaurus-plugin-typedoc-api@npm%3A3.0.1#~/.yarn/patches/docusaurus-plugin-typedoc-api-npm-3.0.1-7dd061feb2.patch":
84748474
version: 3.0.1
8475-
resolution: "docusaurus-plugin-typedoc-api@patch:docusaurus-plugin-typedoc-api@npm%3A3.0.1#~/.yarn/patches/docusaurus-plugin-typedoc-api-npm-3.0.1-7dd061feb2.patch::version=3.0.1&hash=690901"
8475+
resolution: "docusaurus-plugin-typedoc-api@patch:docusaurus-plugin-typedoc-api@npm%3A3.0.1#~/.yarn/patches/docusaurus-plugin-typedoc-api-npm-3.0.1-7dd061feb2.patch::version=3.0.1&hash=2fc7b0"
84768476
dependencies:
84778477
"@docusaurus/plugin-content-docs": "npm:^2.4.3"
84788478
"@docusaurus/types": "npm:^2.4.3"
@@ -8484,7 +8484,7 @@ __metadata:
84848484
"@docusaurus/core": ^2.0.0
84858485
react: ">=16.0.0"
84868486
typescript: ^4.0.0 || ^5.0.0
8487-
checksum: 6f68daceda63fe15120bcd9d9b5583e633ee3f7003257f92ed4e204d3bb8515e818c9a1e153144d314345a75d7d0c5006a49148709786ef146f2bc66b1b5d384
8487+
checksum: a52a91cefa948f869cca91a992da53e355f1d1d3693a7856198ea86e72ae6620d7255a75443da96701f0698b83add86036a08c93abf8a33803d7e191ee47c1a4
84888488
languageName: node
84898489
linkType: hard
84908490

0 commit comments

Comments
 (0)