Add possibility to hide documentation pages

Fixes #167
vertx-web-site · Nov 30, 2024 · 4a23038 · 4a23038
1 parent 956dd5f
commit 4a23038
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/app/sitemap.tsx b/app/sitemap.tsx
@@ -19,7 +19,9 @@ export default function sitemap(): MetadataRoute.Sitemap {
   for (let version of filteredVersions) {
     let toc = makeToc("docs", version)
     for (let chapter of toc) {
-      let filteredPages = chapter.pages.filter(page => !isExternal(page.slug))
+      let filteredPages = chapter.pages.filter(
+        page => !isExternal(page.slug) && page.hidden !== true,
+      )
       for (let page of filteredPages) {
         let slug = page.slug
         if (slug !== "") {

diff --git a/components/docs/SidebarLeft.tsx b/components/docs/SidebarLeft.tsx
@@ -35,8 +35,11 @@ function createToc(
       <li key={titleSlug}>
         <div className="mb-2 font-normal text-gray-900">{chapter.title}</div>
         <ul className="flex flex-col gap-2 border-l border-gray-200">
-          {chapter.pages.map(p => {
+          {chapter.pages.flatMap(p => {
             let ext = isExternal(p.slug)
+            if (p.hidden ?? false) {
+              return []
+            }
             return (
               <li
                 key={p.slug}

diff --git a/components/docs/Toc.tsx b/components/docs/Toc.tsx
@@ -15,6 +15,7 @@ export interface Page {
   readonly title: string
   readonly slug: string
   readonly label?: string
+  readonly hidden?: boolean
   readonly edit?: string
   readonly examples?: string
   readonly includeBook?: boolean
@@ -256,6 +257,7 @@ function makeChapters(
         title: e.name,
         slug: pageSlug,
         label: e.label,
+        hidden: e.hidden,
         edit: e.edit,
         examples: e.examples,
         sections,

diff --git a/docs/metadata/types.ts b/docs/metadata/types.ts
@@ -16,6 +16,7 @@ export interface Doc {
   edit: string
   examples?: string
   label?: string
+  hidden?: boolean
 }
 
 export interface GuidesDoc extends Doc {

diff --git a/scraper/src/worker.ts b/scraper/src/worker.ts
@@ -59,6 +59,10 @@ async function workerMain({ version }: { version: string }) {
       // skip external pages
       continue
     }
+    if (e.hidden ?? false) {
+      // skip hidden pages
+      continue
+    }
     let slug = e.href
     if (slug.startsWith("/")) {
       slug = slug.substring(1)