feat(API): Add API only build mode (#229)

wise-king-sullyman · web-flow · commit 10aeffcf76ae · 2026-03-31T11:21:31.000-04:00
* feat(API): Add API only build mode

* Move api only check before getting collections
diff --git a/cli/cli.ts b/cli/cli.ts
@@ -113,7 +113,11 @@ async function initializeApiIndex(program: Command) {
 }
 
 async function buildProject(program: Command): Promise<DocsConfig | undefined> {
-  const { verbose } = program.opts()
+  const { verbose, apiOnly } = program.opts()
+
+  if (apiOnly) {
+    process.env.PF_API_ONLY = 'true'
+  }
 
   if (!config) {
     console.error(
@@ -191,6 +195,7 @@ program.name('pf-doc-core')
 program.option('--verbose', 'verbose mode', false)
 program.option('--props', 'generate props data', false)
 program.option('--dry-run', 'dry run mode', false)
+program.option('--api-only', 'only build API and component pages, skip standalone content pages', false)
 
 program.command('setup').action(async () => {
   await Promise.all([
@@ -212,6 +217,10 @@ program.command('init').action(async () => {
 })
 
 program.command('start').action(async () => {
+  const { apiOnly } = program.opts()
+  if (apiOnly) {
+    process.env.PF_API_ONLY = 'true'
+  }
   await updateContent(program)
   await initializeApiIndex(program)
 
diff --git a/src/pages/404.astro b/src/pages/404.astro
@@ -0,0 +1,22 @@
+---
+const apiOnly = process.env.PF_API_ONLY === 'true'
+---
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width" />
+    <title>404 - Not Found</title>
+  </head>
+  <body>
+    {apiOnly ? (
+      <>
+        <h1>404 - Not Found</h1>
+        <p>This build only serves API routes. Content pages are not available.</p>
+        <p>Available endpoints are under <a href="/api">/api</a>.</p>
+      </>
+    ) : (
+      <h1>404 - Page not found</h1>
+    )}
+  </body>
+</html>
diff --git a/src/pages/[section]/[...page].astro b/src/pages/[section]/[...page].astro
@@ -30,6 +30,12 @@ import {
 import DocsTables from '../../components/DocsTables.astro'
 
 export async function getStaticPaths() {
+  const apiOnly = process.env.PF_API_ONLY === 'true'
+
+  if (apiOnly) {
+    return []
+  }
+  
   const collections = await Promise.all(
     content.map(
       async (entry) => await getCollection(entry.name as 'textContent'),
diff --git a/src/pages/[section]/[page]/[tab].astro b/src/pages/[section]/[page]/[tab].astro
@@ -31,6 +31,12 @@ import DocsTables from '../../../components/DocsTables.astro'
 import { addDemosOrDeprecated, getDefaultTab } from '../../../utils'
 
 export async function getStaticPaths() {
+  const apiOnly = process.env.PF_API_ONLY === 'true'
+
+  if (apiOnly) {
+    return []
+  }
+  
   const collections = await Promise.all(
     content.map(
       async (entry) => await getCollection(entry.name as 'textContent'),
diff --git a/src/pages/index.astro b/src/pages/index.astro
@@ -1,5 +1,7 @@
 ---
 import MainLayout from '../layouts/Main.astro'
+
+const apiOnly = process.env.PF_API_ONLY === 'true'
 ---
 
 <html lang="en">
@@ -11,6 +13,14 @@ import MainLayout from '../layouts/Main.astro'
     <title>PatternFly</title>
   </head>
   <body>
-    <MainLayout title="PatternFly X Astro"> Page content </MainLayout>
+    {apiOnly ? (
+      <>
+        <h1>PatternFly API</h1>
+        <p>This build only serves API routes. Content pages are not available.</p>
+        <p>Available endpoints are under <a href="/api">/api</a>.</p>
+      </>
+    ) : (
+      <MainLayout title="PatternFly X Astro"> Page content </MainLayout>
+    )}
   </body>
 </html>
