Skip to content

Commit 31b6778

Browse files
authored
Merge pull request #723 from dahlia/docs/jsr-ref
Link docs refs across Fedify packages
2 parents 94d98c0 + afc626e commit 31b6778

4 files changed

Lines changed: 28 additions & 12 deletions

File tree

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.jsr-cache.json
2+
.jsr-*-cache.json
23
.vitepress/cache/
34
.vitepress/dist/
45
node_modules/

docs/.vitepress/config.mts

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,24 @@ import {
1515
import llmstxt from "vitepress-plugin-llms";
1616
import { withMermaid } from "vitepress-plugin-mermaid";
1717

18-
const jsrRefPlugin = await jsrRef({
19-
package: "@fedify/fedify",
20-
version: process.env.JSR_REF_VERSION ?? "unstable",
21-
cachePath: ".jsr-cache.json",
22-
});
18+
const jsrRefVersion = process.env.JSR_REF_VERSION ?? "unstable";
19+
const jsrRefPackages = [
20+
["@fedify/fedify", ".jsr-cache.json"],
21+
["@fedify/vocab", ".jsr-vocab-cache.json"],
22+
["@fedify/vocab-runtime", ".jsr-vocab-runtime-cache.json"],
23+
["@fedify/webfinger", ".jsr-webfinger-cache.json"],
24+
["@fedify/debugger", ".jsr-debugger-cache.json"],
25+
["@fedify/testing", ".jsr-testing-cache.json"],
26+
] as const;
27+
const jsrRefPlugins = await Promise.all(
28+
jsrRefPackages.map(([packageName, cachePath]) =>
29+
jsrRef({
30+
package: packageName,
31+
version: jsrRefVersion,
32+
cachePath,
33+
})
34+
),
35+
);
2336

2437
let extraNav: { text: string; link: string }[] = [];
2538
if (process.env.EXTRA_NAV_TEXT && process.env.EXTRA_NAV_LINK) {
@@ -300,7 +313,9 @@ export default withMermaid(defineConfig({
300313
md.use(footnote);
301314
md.use(taskLists);
302315
md.use(groupIconMdPlugin);
303-
md.use(jsrRefPlugin);
316+
for (const jsrRefPlugin of jsrRefPlugins) {
317+
md.use(jsrRefPlugin);
318+
}
304319
},
305320
},
306321
sitemap: {

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"markdown-it-abbr": "^2.0.0",
5757
"markdown-it-deflist": "^3.0.0",
5858
"markdown-it-footnote": "^4.0.0",
59-
"markdown-it-jsr-ref": "0.4.1",
59+
"markdown-it-jsr-ref": "0.4.4",
6060
"mermaid": "^11.4.1",
6161
"postgres": "catalog:",
6262
"srvx": "^0.11.15",

pnpm-lock.yaml

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)