Skip to content

Commit 5500b2f

Browse files
committed
docs: πŸ“šοΈ remove require.resolveWeak polyfill
1 parent ee17199 commit 5500b2f

11 files changed

Lines changed: 13948 additions & 4366 deletions

File tree

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: true
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: pnpm/action-setup@v3
22+
with:
23+
version: 10
24+
- uses: actions/setup-node@v4
25+
with:
26+
node-version: 22
27+
cache: "pnpm"
28+
- run: pnpm install --frozen-lockfile
29+
- run: pnpm --filter docs build
30+
- uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: apps/docs/build
33+
34+
deploy:
35+
needs: build
36+
runs-on: ubuntu-latest
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deploy.outputs.page_url }}
40+
steps:
41+
- id: deploy
42+
uses: actions/deploy-pages@v4

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ coverage
1212
.next/
1313
out/
1414
build
15+
.docusaurus
1516

1617
# misc
1718
.DS_Store

β€Žapps/docs/docs/.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
plugins/

β€Žapps/docs/docs/intro.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Docusaurus Plugins
2+
3+
Documentation for the plugins in this repository.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import type { Config } from "@docusaurus/types";
2+
3+
const config: Config = {
4+
baseUrl: "/docusaurus-plugins/",
5+
favicon: "img/favicon.ico",
6+
onBrokenLinks: "throw",
7+
onBrokenMarkdownLinks: "warn",
8+
organizationName: "gracefullight",
9+
presets: [
10+
[
11+
"classic",
12+
{
13+
blog: false,
14+
docs: {
15+
sidebarPath: "./sidebars.ts",
16+
},
17+
},
18+
],
19+
],
20+
projectName: "docusaurus-plugins",
21+
title: "docusaurus-plugins",
22+
url: "https://gracefullight.github.io",
23+
};
24+
25+
export default config;

β€Žapps/docs/package.jsonβ€Ž

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"dependencies": {
3+
"@docusaurus/core": "3.8.0",
4+
"@docusaurus/preset-classic": "3.8.0",
5+
"@mdx-js/react": "^3.1.1",
6+
"react": "^18.2.0",
7+
"react-dom": "^18.2.0"
8+
},
9+
"name": "docs",
10+
"private": true,
11+
"scripts": {
12+
"build": "pnpm prepare-docs && docusaurus build",
13+
"prepare-docs": "tsx ./scripts/prepare-docs.ts",
14+
"start": "pnpm prepare-docs && docusaurus start"
15+
},
16+
"type": "module"
17+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { access, copyFile, mkdir, readdir, rm } from "node:fs/promises";
2+
import { join } from "node:path";
3+
4+
const root = join(process.cwd(), "..", "..", "packages");
5+
const outDir = join(process.cwd(), "docs", "plugins");
6+
7+
await rm(outDir, { force: true, recursive: true });
8+
await mkdir(outDir, { recursive: true });
9+
10+
const packages = await readdir(root, { withFileTypes: true });
11+
12+
for (const dir of packages) {
13+
if (!dir.isDirectory() || dir.name === "tsconfig") continue;
14+
const readme = join(root, dir.name, "README.md");
15+
try {
16+
await access(readme);
17+
await copyFile(readme, join(outDir, `${dir.name}.md`));
18+
} catch {
19+
/* ignore */
20+
}
21+
}

β€Žapps/docs/sidebars.tsβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
2+
3+
const sidebars: SidebarsConfig = {
4+
docs: ["intro", { dirName: "plugins", type: "autogenerated" }],
5+
};
6+
7+
export default sidebars;

β€Žapps/docs/tsconfig.jsonβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "../../packages/tsconfig/base.json",
3+
"include": ["."]
4+
}

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"husky": "^9.1.7",
1616
"lint-staged": "^16.1.0",
1717
"tsup": "^8.5.0",
18+
"tsx": "^4.20.5",
1819
"turbo": "^2.5.4"
1920
},
2021
"engines": {

0 commit comments

Comments
Β (0)