@marlinjai/clearify 1.12.0 → 1.13.0

package/README.md

@@ -14,6 +14,7 @@ An open-source documentation site generator. Turn markdown into beautiful docs.
 - **OpenAPI API Reference** — custom-built renderer for OpenAPI specs with code examples, schema viewer, and full design system integration
 - **Multi-section support** — pill-based section switcher (e.g. public docs + internal docs)
 - **Auto changelog** — drop a `CHANGELOG.md` in your project root, it appears as `/changelog`
+- **README as landing page** — optionally include your project's `README.md` as the docs overview page
 
 ## Quick Start
 

package/dist/node/{chunk-2WLFSQS7.js → chunk-2WML2D77.js}

@@ -100,7 +100,8 @@ var ClearifyConfigSchema = z.object({
   hub: HubConfigSchema,
   hubProject: HubProjectPartialSchema,
   customCss: z.string().optional(),
-  headTags: z.array(z.string()).optional()
+  headTags: z.array(z.string()).optional(),
+  includeReadme: z.boolean().default(false)
 });
 var ClearifyDataSchema = z.object({
   name: z.string().optional(),

package/dist/node/{chunk-QTGT76RY.js → chunk-CTL4YL7C.js}

@@ -133,9 +133,30 @@ function buildRoutes(docs, sectionId) {
     ...sectionId ? { sectionId } : {}
   }));
 }
+function extractReadmeTitle(content) {
+  const match = content.match(/^#\s+(.+)$/m);
+  return match ? match[1].trim() : "Overview";
+}
 function buildSectionData(section, rootFiles, customNavigation) {
   const docs = scanDocs(section.docsDir, section.exclude, section.basePath);
   if (section.basePath === "/") {
+    if (rootFiles?.readmePath && existsSync(rootFiles.readmePath)) {
+      const hasIndex = docs.some((d) => d.routePath === "/");
+      if (!hasIndex) {
+        const content = readFileSync(rootFiles.readmePath, "utf-8");
+        const { data } = matter(content);
+        const title = extractReadmeTitle(content);
+        docs.unshift({
+          filePath: rootFiles.readmePath,
+          routePath: "/",
+          frontmatter: {
+            title: data.title ?? title,
+            description: data.description ?? "Project overview",
+            order: -1
+          }
+        });
+      }
+    }
     if (rootFiles?.changelogPath && existsSync(rootFiles.changelogPath)) {
       const content = readFileSync(rootFiles.changelogPath, "utf-8");
       const { data } = matter(content);

package/dist/node/{chunk-XYS5SV4M.js → chunk-GWYMXKDL.js}

@@ -10,10 +10,10 @@ import {
   resolveSections,
   scanHubProjects,
   writeDataConfig
-} from "./chunk-2WLFSQS7.js";
+} from "./chunk-2WML2D77.js";
 import {
   buildSectionData
-} from "./chunk-QTGT76RY.js";
+} from "./chunk-CTL4YL7C.js";
 
 // src/vite-plugin/index.ts
 import { resolve, dirname } from "path";
@@ -59,7 +59,8 @@ function clearifyPlugin(options = {}) {
   function getRootFiles() {
     return {
       changelogPath: resolve(userRoot, "CHANGELOG.md"),
-      roadmapPath: resolve(userRoot, "ROADMAP.md")
+      roadmapPath: resolve(userRoot, "ROADMAP.md"),
+      ...config.includeReadme ? { readmePath: resolve(userRoot, "README.md") } : {}
     };
   }
   async function refreshDocs() {
@@ -285,7 +286,7 @@ ${routeEntries.join(",\n")}
         server.watcher.add(section.docsDir);
       }
       const rootFiles = getRootFiles();
-      for (const rootFile of [rootFiles.changelogPath, rootFiles.roadmapPath]) {
+      for (const rootFile of [rootFiles.changelogPath, rootFiles.roadmapPath, rootFiles.readmePath]) {
         if (rootFile && existsSync(rootFile)) {
           server.watcher.add(rootFile);
         }
@@ -407,8 +408,9 @@ ${routeEntries.join(",\n")}
       server.watcher.on("all", (event, path) => {
         const isChangelog = path === rootFiles.changelogPath;
         const isRoadmap = path === rootFiles.roadmapPath;
+        const isReadme = path === rootFiles.readmePath;
         const isInSection = visibleSections.some((s) => path.startsWith(s.docsDir));
-        if (!isChangelog && !isRoadmap && !isInSection) return;
+        if (!isChangelog && !isRoadmap && !isReadme && !isInSection) return;
         if (!path.endsWith(".md") && !path.endsWith(".mdx")) return;
         if (event === "add" || event === "unlink" || event === "change") {
           refreshDocs().then(() => {

package/dist/node/{chunk-6XHVO5AO.js → chunk-HZRIVY25.js}

@@ -2,10 +2,10 @@ import {
   loadUserConfig,
   resolveConfig,
   resolveSections
-} from "./chunk-2WLFSQS7.js";
+} from "./chunk-2WML2D77.js";
 import {
   scanDocs
-} from "./chunk-QTGT76RY.js";
+} from "./chunk-CTL4YL7C.js";
 
 // src/node/check.ts
 import { resolve, relative } from "path";

package/dist/node/{chunk-6YAEHWC7.js → chunk-XR4WG237.js}

@@ -8,15 +8,15 @@ import {
 } from "./chunk-SCZZB7OE.js";
 import {
   clearifyPlugin
-} from "./chunk-XYS5SV4M.js";
+} from "./chunk-GWYMXKDL.js";
 import {
   loadUserConfig,
   resolveConfig,
   resolveSections
-} from "./chunk-2WLFSQS7.js";
+} from "./chunk-2WML2D77.js";
 import {
   buildSectionData
-} from "./chunk-QTGT76RY.js";
+} from "./chunk-CTL4YL7C.js";
 
 // src/node/build.ts
 import { build as viteBuild } from "vite";
@@ -157,7 +157,8 @@ async function buildSite() {
   const productionSections = allSections.filter((s) => !s.draft);
   const rootFiles = {
     changelogPath: resolve(userRoot, "CHANGELOG.md"),
-    roadmapPath: resolve(userRoot, "ROADMAP.md")
+    roadmapPath: resolve(userRoot, "ROADMAP.md"),
+    ...config.includeReadme ? { readmePath: resolve(userRoot, "README.md") } : {}
   };
   const sectionDataList = productionSections.map(
     (section) => buildSectionData(section, rootFiles, config.navigation)

package/dist/node/core/config.js

@@ -8,7 +8,7 @@ import {
   resolveSections,
   scanHubProjects,
   writeDataConfig
-} from "../chunk-2WLFSQS7.js";
+} from "../chunk-2WML2D77.js";
 import "../chunk-AJBCHKBP.js";
 import {
   defineConfig

package/dist/node/core/navigation.js

@@ -3,7 +3,7 @@ import {
   buildRoutes,
   buildSectionData,
   scanDocs
-} from "../chunk-QTGT76RY.js";
+} from "../chunk-CTL4YL7C.js";
 import "../chunk-5TD7NQIW.js";
 export {
   buildNavigation,

package/dist/node/core/search.d.ts

@@ -29,6 +29,7 @@ interface SectionData {
 interface RootFileOptions {
     changelogPath?: string;
     roadmapPath?: string;
+    readmePath?: string;
 }
 declare function buildSectionData(section: ResolvedSection, rootFiles?: RootFileOptions, customNavigation?: NavigationItem[] | null): SectionData;
 

package/dist/node/node/build.js

@@ -1,14 +1,14 @@
 import {
   buildSite
-} from "../chunk-6YAEHWC7.js";
+} from "../chunk-XR4WG237.js";
 import "../chunk-PRTER35L.js";
 import "../chunk-SCZZB7OE.js";
-import "../chunk-XYS5SV4M.js";
+import "../chunk-GWYMXKDL.js";
 import "../chunk-B2Q23JW3.js";
-import "../chunk-2WLFSQS7.js";
+import "../chunk-2WML2D77.js";
 import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
-import "../chunk-QTGT76RY.js";
+import "../chunk-CTL4YL7C.js";
 import "../chunk-5TD7NQIW.js";
 export {
   buildSite

package/dist/node/node/check.js

@@ -1,11 +1,11 @@
 import {
   checkFrontmatter,
   checkLinks
-} from "../chunk-6XHVO5AO.js";
-import "../chunk-2WLFSQS7.js";
+} from "../chunk-HZRIVY25.js";
+import "../chunk-2WML2D77.js";
 import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
-import "../chunk-QTGT76RY.js";
+import "../chunk-CTL4YL7C.js";
 import "../chunk-5TD7NQIW.js";
 export {
   checkFrontmatter,

package/dist/node/node/index.js

@@ -1,13 +1,13 @@
 import {
   buildSite
-} from "../chunk-6YAEHWC7.js";
+} from "../chunk-XR4WG237.js";
 import {
   remarkMermaidToComponent
 } from "../chunk-PRTER35L.js";
 import "../chunk-SCZZB7OE.js";
 import {
   clearifyPlugin
-} from "../chunk-XYS5SV4M.js";
+} from "../chunk-GWYMXKDL.js";
 import "../chunk-B2Q23JW3.js";
 import {
   init
@@ -15,14 +15,14 @@ import {
 import {
   checkFrontmatter,
   checkLinks
-} from "../chunk-6XHVO5AO.js";
+} from "../chunk-HZRIVY25.js";
 import {
   loadUserConfig,
   resolveConfig
-} from "../chunk-2WLFSQS7.js";
+} from "../chunk-2WML2D77.js";
 import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
-import "../chunk-QTGT76RY.js";
+import "../chunk-CTL4YL7C.js";
 import "../chunk-5TD7NQIW.js";
 
 // src/node/index.ts

package/dist/node/types/index.d.ts

@@ -61,6 +61,7 @@ interface ClearifyConfig {
     hubProject?: Omit<HubProject, 'name'>;
     customCss?: string;
     headTags?: string[];
+    includeReadme?: boolean;
 }
 interface NavigationItem {
     label: string;

package/dist/node/vite-plugin/index.js

@@ -1,11 +1,11 @@
 import {
   clearifyPlugin
-} from "../chunk-XYS5SV4M.js";
+} from "../chunk-GWYMXKDL.js";
 import "../chunk-B2Q23JW3.js";
-import "../chunk-2WLFSQS7.js";
+import "../chunk-2WML2D77.js";
 import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
-import "../chunk-QTGT76RY.js";
+import "../chunk-CTL4YL7C.js";
 import "../chunk-5TD7NQIW.js";
 export {
   clearifyPlugin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marlinjai/clearify",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "An open-source documentation site generator. Turn markdown into beautiful docs.",
   "type": "module",
   "bin": {