Skip to content

Optimize linkcheck build llms generation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yusaku01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Optimize linkcheck build llms generation #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ import { remarkFallbackLang } from './config/plugins/remark-fallback-lang';
const NETLIFY_PREVIEW_SITE = process.env.CONTEXT !== 'production' && process.env.DEPLOY_PRIME_URL;

const site = NETLIFY_PREVIEW_SITE || 'https://docs.astro.build/';
const starlightPlugins = [
starlightPluginSmokeTest(),
...(process.env.SKIP_LLMS ? [] : [starlightPluginLlmsTxt()]),
];

// https://astro.build/config
export default defineConfig({
Expand Down Expand Up @@ -69,7 +73,7 @@ export default defineConfig({
},
],
disable404Route: true,
plugins: [starlightPluginSmokeTest(), starlightPluginLlmsTxt()],
plugins: starlightPlugins,
}),
sitemap(),
],
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"build:linkcheck": "SKIP_OG=true SKIP_LLMS=true pnpm build && node ./scripts/write-linkcheck-llms-stubs.mjs",
"preview": "astro preview",
"check": "astro check",
"format": "pnpm run format:code",
Expand All @@ -15,7 +16,7 @@
"format:imports": "echo 'Skipped formatting imports'",
"docgen": "node ./scripts/docgen.mjs",
"docgen:errors": "node ./scripts/error-docgen.mjs",
"lint:linkcheck": "SKIP_OG=true pnpm build && node --experimental-transform-types ./scripts/lint-linkcheck.ts",
"lint:linkcheck": "pnpm build:linkcheck && node --experimental-transform-types ./scripts/lint-linkcheck.ts",
"lint:linkcheck:nobuild": "node --experimental-transform-types ./scripts/lint-linkcheck.ts",
"lint:slugcheck": "node ./scripts/lint-slugcheck.mjs",
"lint:eslint": "eslint .",
Expand Down
14 changes: 14 additions & 0 deletions scripts/write-linkcheck-llms-stubs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { mkdir, writeFile } from 'node:fs/promises';

const distDir = new URL('../dist/', import.meta.url);
const llmsFiles = [
['llms.txt', '# Linkcheck-only stub\n'],
['llms-full.txt', '# Linkcheck-only stub\n'],
['llms-small.txt', '# Linkcheck-only stub\n'],
];

await mkdir(distDir, { recursive: true });

await Promise.all(
llmsFiles.map(([name, contents]) => writeFile(new URL(name, distDir), contents, 'utf8'))
);
Loading