@writedocs/generator 0.9.4 → 0.10.1

package/src/lib/hidden-sections.js

@@ -0,0 +1,58 @@
+// Hidden navigation items (`"hidden": true` on a tab, product, version,
+// language or dropdown): reachable only by their address.
+//
+// - Nothing lists one: its switcher, tab row or menu option is left out
+//   everywhere, and `/` never redirects into it (firstSlugAmong() in
+//   lib/config.ts skips it).
+// - Inside one, the level it sits on isn't shown - that switcher would
+//   list the other items at its level. Everything below it works as
+//   usual. (buildSelectors() marks that level `hidden`; the placement in
+//   lib/selector-placement.js leaves it out.)
+// - Its pages are a search space of their own: they search only among
+//   themselves, and the site's public search never finds them. With
+//   `"searchPublic": true` its search finds the public pages too. The
+//   build writes one index per space (cli/run-pagefind.js); a page names
+//   its space in the markup, and src/scripts/search.ts loads that index.
+//
+// Hidden isn't private: anyone with the address can read the pages. The
+// sitemap, llms.txt and the MCP index still list them unless a page sets
+// `noindex`.
+
+/** Whether a navigation item is hidden. */
+export function isHidden(item) {
+  return Boolean(item && typeof item === 'object' && item.hidden === true);
+}
+
+const NAME_FIELD = { tab: 'tab', version: 'version', language: 'language', dropdown: 'dropdown', product: 'product' };
+
+function slug(text) {
+  return String(text ?? '')
+    .normalize('NFKD')
+    .replace(/[̀-ͯ]/g, '')
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '');
+}
+
+/** A path's id, from the names of its levels - "product-admin",
+ *  "tab-api--version-v2". Readable in the index folder's name, and the
+ *  same on every build. */
+export function spaceIdOf(path) {
+  return path
+    .map((segment) => {
+      const item = segment.items[segment.index] ?? {};
+      return `${segment.kind}-${slug(item[NAME_FIELD[segment.kind]]) || segment.index}`;
+    })
+    .join('--');
+}
+
+/** The search space a section belongs to: the innermost hidden item on its
+ *  path - `{ id, searchPublic }` - or null for the public pages. */
+export function spaceOf(path = []) {
+  let space = null;
+  path.forEach((segment, i) => {
+    const item = segment.items[segment.index];
+    if (isHidden(item)) space = { id: spaceIdOf(path.slice(0, i + 1)), searchPublic: item.searchPublic === true };
+  });
+  return space;
+}

package/src/lib/json-schema-descriptions.js

@@ -43,9 +43,15 @@ const CONTAINERS = {
   },
 };
 
+const HIDDEN = {
+  hidden: 'Reachable only by its address: no tab, switcher or menu lists it, and inside it this level isn\'t shown. Its pages search only among themselves.',
+  searchPublic: 'For a hidden item: its search also finds the site\'s public pages.',
+};
+
 const containerEntries = Object.entries(CONTAINERS).flatMap(([type, fields]) => [
   ...Object.entries(fields).map(([field, text]) => [`${type}.${field}`, text]),
   ...Object.entries(CHILDREN).map(([field, text]) => [`${type}.${field}`, text]),
+  ...Object.entries(HIDDEN).map(([field, text]) => [`${type}.${field}`, text]),
 ]);
 
 const logo = (where) => ({

package/src/lib/link-check.js

@@ -35,6 +35,7 @@ import { visit } from 'unist-util-visit';
 import { findAllPages } from './pages.js';
 import { createJsonLocator, contextMenuOptions } from './config-schema.js';
 import { writedocsTempDir } from './writedocs-temp-dir.js';
+import { folderAddresses } from './folder-redirects.js';
 
 // The same github-slugger Astro builds page URLs and heading ids with -
 // resolved through Astro itself, so the two can't drift apart.
@@ -295,6 +296,11 @@ export async function checkLinks(contentDir, configText) {
   const special = new Set(['/llms.txt', '/llms-full.txt', '/404.html', '/404/']);
   if (config.domain) ['/sitemap.xml', '/sitemap-index.xml'].forEach((p) => special.add(p));
   const knownUrls = [...pages.keys(), ...generated, ...redirects];
+  // Folder addresses with no page of their own redirect to one under them
+  // (lib/folder-redirects.js), so a link to one isn't broken.
+  const folders = new Set(
+    [...folderAddresses([...pages.keys(), ...generated].map((url) => url.replace(/^\/+|\/+$/g, '')))].map((folder) => `/${folder}/`)
+  );
 
   // Anchors a page can be linked to: its own, plus those of every snippet
   // it imports (they render inside it).
@@ -398,7 +404,7 @@ export async function checkLinks(contentDir, configText) {
         return;
       }
       // "/" always exists: the home page, or a redirect to the first page.
-      if (pageKey === '/' || generated.has(pageKey) || redirects.has(pageKey) || special.has(pageKey.replace(/\/$/, '') || '/')) return;
+      if (pageKey === '/' || generated.has(pageKey) || redirects.has(pageKey) || folders.has(pageKey) || special.has(pageKey.replace(/\/$/, '') || '/')) return;
       if (special.has(pathname)) return;
 
       // Mintlify-style relative link: resolved from the file's folder

package/src/lib/selector-placement.js

@@ -6,6 +6,8 @@
 //   'sidebar'   the top of the sidebar: products inside a tab or a dropdown,
 //               like Mintlify's - they pick what the sidebar shows
 //   'topbar'    a switcher next to the site name (everything else)
+//   'none'      not shown: the page is inside a hidden item on this level
+//               (lib/hidden-sections.js)
 //
 // Without a sidebar on the page (`mode: custom` / `blank`), a 'sidebar'
 // switcher goes to the top bar instead. The mobile menu lists every level
@@ -13,6 +15,7 @@
 
 export function selectorPlacements(selectors, { sidebar = true } = {}) {
   return selectors.map((sel, i) => {
+    if (sel.hidden) return 'none';
     const parent = selectors[i - 1]?.kind;
     if (sel.kind === 'tab') return 'tabs';
     if (sel.kind === 'dropdown' && parent === 'tab') return 'tab-menu';
@@ -26,5 +29,5 @@ export function selectorPlacements(selectors, { sidebar = true } = {}) {
  *  top bar hides the tabs and switchers, so any page with navigation to
  *  reach needs it - with a sidebar or without (`mode: custom`). */
 export function hasMobileMenu({ sidebar, selectors = [], globalDropdowns = [] }) {
-  return sidebar || selectors.length > 0 || globalDropdowns.length > 0;
+  return sidebar || selectors.some((sel) => !sel.hidden) || globalDropdowns.length > 0;
 }

package/src/pages/[...slug].astro

@@ -71,6 +71,8 @@ import ApiPlayground from "../components/ApiPlayground.astro";
 import ApiReferencePanel from "../components/ApiReferencePanel.astro";
 import { searchScope, sectionTrail, ALL_SCOPES } from "../lib/search-scope.js";
 import { selectorPlacements } from "../lib/selector-placement.js";
+import { spaceOf } from "../lib/hidden-sections.js";
+import { folderRedirects } from "../lib/folder-redirects.js";
 
 // A page is hand-written (the `pages` collection, sourced from anywhere
 // in the project - docs/ has no special status, see findAllPages() in
@@ -254,12 +256,34 @@ export async function getStaticPaths() {
       };
     });
 
-  return [...rootRedirect, ...pageRoutes, ...hiddenRoutes];
+  // Folder addresses with pages under them but none of their own
+  // (`/docs/creator/`) redirect to the first page under them
+  // (lib/folder-redirects.js). Preferred in the reader's order: navigation
+  // order, public sections before hidden ones, pages outside the
+  // navigation last.
+  const slugOf = (route: { params: { slug?: string } }) => route.params.slug ?? "index";
+  const inHiddenSection = sections.map((section) => spaceOf(section.path) !== null);
+  const contentRoutes = pageRoutes.filter((route) => !("redirectTo" in route.props));
+  const folderTargets = [
+    ...contentRoutes.filter((route) => !inHiddenSection[(route.props as { sectionIndex: number }).sectionIndex]).map(slugOf),
+    ...contentRoutes.filter((route) => inHiddenSection[(route.props as { sectionIndex: number }).sectionIndex]).map(slugOf),
+    ...hiddenRoutes.map(slugOf),
+  ];
+  const takenAddresses = new Set([
+    ...[...pageRoutes, ...hiddenRoutes].map(slugOf),
+    ...(config.redirects ?? []).map((r) => r.source.replace(/^\/+|\/+$/g, "")),
+  ]);
+  const folderRoutes = [...folderRedirects(folderTargets, takenAddresses)].map(([folder, target]) => ({
+    params: { slug: folder },
+    props: { redirectTo: `/${target}/`, temporary: true },
+  }));
+
+  return [...rootRedirect, ...pageRoutes, ...hiddenRoutes, ...folderRoutes];
 }
 
 interface Props {
   redirectTo?: string;
-  // The automatic "/" redirect: temporary, see below.
+  // The automatic "/" and folder redirects: temporary, see below.
   temporary?: boolean;
   entry?: DocsEntry;
   prev?: { slug: string; group: string | null } | null;
@@ -386,6 +410,9 @@ const selectors = buildSelectors(activeSection.path, hrefForSlug, activePagePosi
 // shows the reader's own first. A hidden page belongs to no section.
 const pageSearchScope = isHidden ? { key: ALL_SCOPES, label: "" } : searchScope(activeSection.path);
 const pageSectionTrail = isHidden ? "" : sectionTrail(activeSection.path, breadcrumbs);
+// A page under a hidden navigation item searches its own index, not the
+// site's (lib/hidden-sections.js, cli/run-pagefind.js).
+const pageSearchSpace = isHidden ? null : spaceOf(activeSection.path);
 const languageSegment = isHidden ? undefined : activeSection.path.find((segment) => segment.kind === "language");
 const pageLang = languageSegment ? (languageSegment.items[languageSegment.index] as { language: string }).language : undefined;
 const globalDropdowns = buildGlobalDropdowns(
@@ -517,7 +544,7 @@ const components = {
         {entry.data.openapi && <ApiPlayground operation={entry.data.openapi} contentDir={contentDir} />}
         {/* After the content: a result's excerpt shows the section only when
             that's what matched. */}
-        <div hidden data-wd-search-scope={pageSearchScope.key} data-wd-search-scope-label={pageSearchScope.label} data-pagefind-filter={`scope:${pageSearchScope.key}`}>
+        <div hidden data-wd-search-scope={pageSearchScope.key} data-wd-search-scope-label={pageSearchScope.label} data-wd-search-space={pageSearchSpace?.id} data-wd-search-public={pageSearchSpace?.searchPublic ? "true" : undefined} data-pagefind-filter={`scope:${pageSearchScope.key}`}>
           {pageSectionTrail && <span data-pagefind-meta="section">{pageSectionTrail}</span>}
         </div>
       </div>
@@ -543,7 +570,7 @@ const components = {
         </div>
         <Content components={components} />
         {entry.data.openapi && <ApiPlayground operation={entry.data.openapi} contentDir={contentDir} />}
-        <div hidden data-wd-search-scope={pageSearchScope.key} data-wd-search-scope-label={pageSearchScope.label} data-pagefind-filter={`scope:${pageSearchScope.key}`}>
+        <div hidden data-wd-search-scope={pageSearchScope.key} data-wd-search-scope-label={pageSearchScope.label} data-wd-search-space={pageSearchSpace?.id} data-wd-search-public={pageSearchSpace?.searchPublic ? "true" : undefined} data-pagefind-filter={`scope:${pageSearchScope.key}`}>
           {pageSectionTrail && <span data-pagefind-meta="section">{pageSectionTrail}</span>}
         </div>
         {!entry.data.hideFooterPagination && (

package/src/scripts/search.ts

@@ -53,7 +53,10 @@ export function initSearch(root: ParentNode) {
   let loadPromise: Promise<any> | null = null;
   function ensurePagefind() {
     if (!loadPromise) {
-      const pagefindUrl = '/pagefind/pagefind.js';
+      // A page under a hidden navigation item searches its own space's index
+      // (cli/run-pagefind.js, lib/hidden-sections.js); every other page, the site's.
+      const space = document.querySelector<HTMLElement>('[data-wd-search-scope]')?.dataset.wdSearchSpace;
+      const pagefindUrl = space ? `/pagefind-spaces/${encodeURIComponent(space)}/pagefind.js` : '/pagefind/pagefind.js';
       loadPromise = import(/* @vite-ignore */ pagefindUrl)
         .then((mod: any) => {
           pagefind = mod;