@theholocron/astro-config 8.9.0-alpha.4 → 8.9.0-alpha.5

package/README.md

@@ -87,7 +87,7 @@ export default defineConfig({
 });
 ```
 
-`entryPoints` (default `["src/index.ts"]`, relative to the package) and `label` (default "API reference") are optional. `starlight-typedoc` ships TypeScript source, so, like `starlight` and `docsTheme`, you import it in your own config and pass it in; install `starlight-typedoc`, `typedoc` and `typedoc-plugin-markdown` in the site.
+`entryPoints` (default `["src/index.ts"]`, relative to the package), `label` (default "API reference") and `skipErrorChecking` (default `false`) are optional. Set `skipErrorChecking` for a package whose types come from sources TypeDoc cannot type-check on its own, such as this one's from Starlight; TypeDoc then does not stop the build on type errors. `starlight-typedoc` ships TypeScript source, so, like `starlight` and `docsTheme`, you import it in your own config and pass it in; install `starlight-typedoc`, `typedoc` and `typedoc-plugin-markdown` in the site.
 
 ## What it generates
 

package/dist/index.d.ts

@@ -4,25 +4,39 @@ import { docsTheme } from "@theholocron/docs-theme";
 import { createStarlightTypeDocPlugin } from "starlight-typedoc";
 type StarlightSidebar = NonNullable<Parameters<typeof starlight>[0]["sidebar"]>;
 type StarlightPlugins = NonNullable<Parameters<typeof starlight>[0]["plugins"]>;
+/** The docs site's identity: its title, its GitHub repo name and its sidebar. */
 export interface DocsConfig {
+  /** The site title Starlight shows (passed as Starlight's `title`). */
   name: string;
+  /** The repo name under the `theholocron` GitHub org; builds the social link and the default `base` (`/<github>`). */
   github: string;
+  /** The Starlight sidebar definition, passed to Starlight unchanged. */
   sidebar: StarlightSidebar;
 }
+/** Everything `defineConfig` needs to build the Astro config for a Starlight docs site. */
 export interface DocsConfigInput {
+  /** The docs site's name, repo and sidebar. */
   docs: DocsConfig;
+  /** The `starlight` integration, imported by the site's own config so Astro's loader handles it. */
   starlight: typeof starlight;
+  /** The `docsTheme` Starlight plugin from `@theholocron/docs-theme`, imported by the site's own config. */
   docsTheme: typeof docsTheme;
   /** Further Starlight plugins, added after the docs theme (for example the ones `apiReference()` returns). */
   plugins?: StarlightPlugins;
+  /** Astro's `srcDir`. Omitted from the config when unset, so Astro's default (`./src`) applies. */
   srcDir?: string;
+  /** Astro's `outDir`, the build output folder. Omitted from the config when unset, so Astro's default applies. */
   outDir?: string;
+  /** Astro's `publicDir`, the folder of static assets. Omitted from the config when unset, so Astro's default applies. */
   publicDir?: string;
+  /** Astro's `base`, the path the site is served under. Defaults to `/<docs.github>`. */
   base?: string;
   /** The site's absolute origin (for example `https://docs.theholocron.dev`). Starlight needs it to generate a sitemap. */
   site?: string;
 }
+/** Builds the Astro config for a Starlight docs site: the docs theme, a GitHub social link, the React integration and an `@` alias to the docs source folder. */
 export declare function defineConfig({ docs, starlight, docsTheme, plugins, srcDir, outDir, publicDir, base, site }: DocsConfigInput): ReturnType<typeof defineConfig$1>;
+/** Options for `apiReference`. */
 export interface ApiReferenceInput {
   /** `createStarlightTypeDocPlugin` from your own `starlight-typedoc` import, as with `starlight` and `docsTheme`. */
   createPlugin: typeof createStarlightTypeDocPlugin;
@@ -35,6 +49,7 @@ export interface ApiReferenceInput {
   /** The sidebar group's label. Defaults to "API reference". */
   label?: string;
 }
+/** What `apiReference` returns: the Starlight plugin and the sidebar group that belong together. */
 export interface ApiReference {
   /** Add to `defineConfig({ plugins })`. */
   plugin: StarlightPlugins[number];

package/dist/index.js

@@ -2,6 +2,7 @@ import { fileURLToPath } from "node:url";
 import react from "@astrojs/react";
 import { defineConfig as defineConfig$1 } from "astro/config";
 // index.ts
+/** Builds the Astro config for a Starlight docs site: the docs theme, a GitHub social link, the React integration and an `@` alias to the docs source folder. */
 function defineConfig({ docs, starlight, docsTheme, plugins, srcDir, outDir, publicDir, base, site }) {
 	return defineConfig$1({
 		...site && { site },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/astro-config",
-  "version": "8.9.0-alpha.4",
+  "version": "8.9.0-alpha.5",
   "description": "Astro configuration factory for theholocron docs sites.",
   "keywords": [
     "astro",
@@ -45,7 +45,7 @@
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
     "@theholocron/docs-theme": "^1.10.5-alpha.1",
-    "@theholocron/tsconfig": "8.9.0-alpha.4"
+    "@theholocron/tsconfig": "8.9.0-alpha.5"
   },
   "peerDependencies": {
     "@astrojs/react": ">=6.0.0",