astro.config.mjs

// @ts-check
import starlight from "@astrojs/starlight";
import { defineConfig } from "astro/config";
import starlightLlmsTxt from "starlight-llms-txt";
import starlightThemeRapide from "starlight-theme-rapide";

// https://astro.build/config
export default defineConfig({
	site: "https://endform.dev",
	base: "/docs",
	outDir: "./dist/docs",
	trailingSlash: "never",

	build: {
		// This is needed when you want to remove trailing slashes with static output.
		format: "file",
	},

	integrations: [
		starlight({
			title: "Endform docs",
			plugins: [
				starlightThemeRapide(),
				starlightLlmsTxt({
					projectName: "Endform",
					customSets: [
						{
							label: "Getting started",
							paths: [
								"index",
								"guides/getting-started",
								"guides/getting-started/local-cli/**",
								"reference/requirements",
							],
							description:
								"set up Endform and run an existing Playwright suite for the first time",
						},
						{
							label: "Run and configure Endform",
							paths: [
								"explanation/custom-reporters",
								"explanation/transfer-state-to-remote-runners",
								"explanation/webkit-browser-support",
								"guides/getting-started",
								"guides/proxy-via-local",
								"guides/tune-playwright-suite-performance",
								"reference/endform-config*",
								"reference/environment-variables",
								"reference/requirements",
							],
							description:
								"use the Endform CLI with your existing Playwright setup and configure remote test execution",
						},
						{
							label: "Test health and history",
							paths: [
								"explanation/dashboard-analytics",
								"reference/analytics-cli",
								"reference/mcp-server",
								"guides/investigate-test-history-with-ai",
							],
							description:
								"use the dashboard, Endform CLI, or MCP server to find flaky, failing, and slow tests and inspect past runs and traces",
						},
						{
							label: "Debugging tests",
							paths: ["reference/mcp-server", "guides/debug-tests-with-ai"],
							description:
								"set up and use the Endform MCP server to query test history and debug Playwright tests with your AI agent",
						},
						{
							label: "How Endform works",
							paths: [
								"index",
								"explanation/what-is-endform",
								"explanation/how-your-tests-are-run",
							],
							description:
								"what Endform is and how it runs Playwright tests in parallel on isolated machines",
						},
						{
							label: "GitHub Actions, CI, and Vercel",
							paths: [
								"guides/getting-started/github-actions/**",
								"guides/getting-started/other-ci/**",
								"guides/vercel-integration/**",
							],
							description:
								"run Endform in GitHub Actions or another CI system and test Vercel preview deployments",
						},
					],
					minify: {
						whitespace: false,
					},
					customSelectors: {
						all: [".sl-anchor-link", ".selector-panel"],
					},
					promote: ["index", "guides/getting-started"],
					exclude: ["guides/getting-started/*/*/*"],
				}),
			],
			customCss: [
				"@fontsource/inter/400.css",
				"@fontsource/inter/400-italic.css",
				"@fontsource/inter/500.css",
				"@fontsource/inter/600.css",
				"@fontsource/inter/700.css",
				"/src/styles/custom.css",
			],
			components: {
				Sidebar: "./src/components/Sidebar.astro",
			},
			routeMiddleware: "./src/routeData.ts",
			logo: {
				dark: "./src/assets/endform-logo-wordmark-colored-on-dark-padding.svg",
				light:
					"./src/assets/endform-logo-wordmark-colored-on-light-padding.svg",
				replacesTitle: true,
				alt: "Endform logo",
			},
			social: [
				{
					icon: "external",
					label: "Endform Dashboard",
					href: "https://endform.dev/app",
				},
				{
					icon: "discord",
					label: "Discord",
					href: "https://endform.dev/discord",
				},
				{
					icon: "github",
					label: "GitHub",
					href: "https://github.com/endformdev",
				},
			],
			sidebar: [
				{
					label: "Explanation",
					items: [{ autogenerate: { directory: "explanation" } }],
				},
				{
					label: "Guides",
					items: [{ autogenerate: { directory: "guides" } }],
				},
				{
					label: "Tutorial",
					items: [{ autogenerate: { directory: "tutorial" } }],
				},
				{
					label: "Reference",
					items: [{ autogenerate: { directory: "reference" } }],
				},
			],

			head:
				process.env.NODE_ENV === "development"
					? []
					: [
							// Set theme before third-party scripts to avoid a dark flash on light theme.
							{
								tag: "script",
								content: `(() => {
						try {
							const storedTheme = localStorage.getItem("starlight-theme");
							const preferredTheme =
								storedTheme === "light" || storedTheme === "dark"
									? storedTheme
									: window.matchMedia("(prefers-color-scheme: light)").matches
										? "light"
										: "dark";
							document.documentElement.dataset.theme = preferredTheme;
						} catch {
							document.documentElement.dataset.theme = window.matchMedia("(prefers-color-scheme: light)").matches
								? "light"
								: "dark";
						}
					})();`,
							},
							{
								tag: "script",
								attrs: {
									src: "https://web.cmp.usercentrics.eu/modules/autoblocker.js",
								},
							},
							{
								tag: "script",
								attrs: {
									id: "usercentrics-cmp",
									async: true,
									src: "https://web.cmp.usercentrics.eu/ui/loader.js",
									"data-settings-id": "Q-tQAA7pNF0dcE",
								},
							},
							{
								tag: "script",
								attrs: {
									defer: true,
									src: "https://static.cloudflareinsights.com/beacon.min.js",
									"data-cf-beacon":
										'{"token":"962bb11e04cf44df87f086d758a37710"}',
								},
							},
							{
								tag: "script",
								// Google Tag Manager
								content: `(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-MG4F2GKF');`,
							},
							{
								tag: "script",
								attrs: {
									id: "posthog-js",
									type: "text/javascript",
								},
								content: `
					!(function (t, e) {
						var o, n, p, r
						e.__SV ||
							((window.posthog = e),
							(e._i = []),
							(e.init = function (i, s, a) {
								function g(t, e) {
									var o = e.split(".")
									;(2 == o.length && ((t = t[o[0]]), (e = o[1])),
										(t[e] = function () {
											t.push([e].concat(Array.prototype.slice.call(arguments, 0)))
										}))
								}
								;(((p = t.createElement("script")).type = "text/javascript"),
									(p.crossOrigin = "anonymous"),
									(p.async = true),
									(p.src = s.api_host + "/static/array.js"),
									(r = t.getElementsByTagName("script")[0]).parentNode.insertBefore(
										p,
										r
									))
								var u = e
								void 0 !== a ? (u = e[a] = []) : (a = "posthog")
								u.people = u.people || []
								u.toString = function (t) {
									var e = "posthog"
									return ("posthog" !== a && (e += "." + a), t || (e += " (stub)"), e)
								}
								u.people.toString = function () {
									return u.toString(1) + ".people (stub)"
								}
								o =
									"capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys getNextSurveyStep onSessionId".split(
										" "
									)
								for (n = 0; n < o.length; n++) g(u, o[n])
								e._i.push([i, s, a])
							}),
							(e.__SV = 1))
					})(document, window.posthog || [])

					posthog.init("phc_CFBLzSpXHQAX9UYMiHudLL3iYWgXfnUVOCuEd079EV1", {
						ui_host: "eu.posthog.com",
						api_host: "/p5g",
						defaults: "2025-05-24",
						disable_surveys: true,
					})
				`,
							},
							{
								tag: "script",
								attrs: {
									type: "text/javascript",
								},
								content: `
									!function(key) {
										if (window.reb2b) return;
										window.reb2b = {loaded: true};
										var s = document.createElement("script");
										s.async = true;
										s.src = "https://ddwl4m2hdecbv.cloudfront.net/b/" + key + "/" + key + ".js.gz";
										document.getElementsByTagName("script")[0].parentNode.insertBefore(s, document.getElementsByTagName("script")[0]);
									}("VN080H3J986J");`,
							},
						],
		}),
	],
});