chore: opt-in reading time

Author: avivkeller

.changeset/opt-in-reading-time.md

@@ -0,0 +1,5 @@
+---
+'@doc-kit/generator-react': minor
+---
+
+Make reading time opt-in via `showReadingTime`

packages/react/src/html/README.md

@@ -416,7 +416,9 @@ export default ({ metadata }) => (
 - `metadata` {Object} Serialized page metadata — all YAML frontmatter properties
   plus `addedIn`, `basename`, `path`, and any custom user-defined fields.
 - `headings` {Array} Pre-computed table of contents heading entries.
-- `readingTime` {string} Estimated reading time (e.g. `'5 min read'`).
+- `readingTime` {string|undefined} Estimated reading time (e.g. `'5 min read'`).
+  Only present when the `jsx-ast` generator's `showReadingTime` option is
+  enabled.
 - `children` {ComponentChildren} Processed page content.
 
 The `Layout` component receives the props above. Custom Layout components can use

packages/react/src/html/ui/components/Layout/index.jsx

@@ -18,7 +18,7 @@ import SideBar from '#theme/Sidebar';
  * main content, meta bar, and footer. Override via `#theme/Layout` in your
  * configuration's `imports` to customize the entire page structure.
  *
- * @param {{ metadata: import('../../types').SerializedMetadata, headings: Array, readingTime: string, children: import('preact').ComponentChildren }} props
+ * @param {{ metadata: import('../../types').SerializedMetadata, headings: Array, readingTime?: string, children: import('preact').ComponentChildren }} props
  */
 export default ({ metadata, headings, readingTime, children }) => {
   const crossLinkItems = navigation.showCrossLinks

packages/react/src/html/ui/components/MetaBar/index.jsx

@@ -49,7 +49,7 @@ const HeadingValue = ({ value, stability }) => {
 
 /**
  * MetaBar component that displays table of contents and page metadata
- * @param {{ metadata: import('../../types').SerializedMetadata, headings: Array, readingTime: string }} props
+ * @param {{ metadata: import('../../types').SerializedMetadata, headings: Array, readingTime?: string }} props
  */
 export default ({ metadata, headings = [], readingTime }) => {
   const editThisPage = editURL?.replace('{path}', metadata.path);

packages/react/src/jsx-ast/README.md

@@ -14,3 +14,5 @@ The `jsx-ast` generator converts MDAST (Markdown Abstract Syntax Tree) to JSX AS
   for `index.html`. **Default:** `true`.
 - `generateNotFoundPage` {boolean} When `true`, creates a synthetic JSX AST
   entry for `404.html`. **Default:** `true`.
+- `showReadingTime` {boolean} When `true`, computes an estimated reading time
+  for each page and displays it in the MetaBar. **Default:** `false`.

packages/react/src/jsx-ast/index.mjs

@@ -19,6 +19,7 @@ export default {
     generateAllPage: true,
     generateIndexPage: true,
     generateNotFoundPage: true,
+    showReadingTime: false,
   },
 
   hasParallelProcessor: true,

packages/react/src/jsx-ast/types.d.ts

@@ -7,6 +7,7 @@ export type Generator = GeneratorMetadata<
     generateAllPage: boolean;
     generateIndexPage: boolean;
     generateNotFoundPage: boolean;
+    showReadingTime: boolean;
   },
   Generate<Array<MetadataEntry>, AsyncGenerator<JSXContent>>,
   ProcessChunk<

packages/react/src/jsx-ast/utils/buildContent.mjs

@@ -320,11 +320,15 @@ export const createDocumentLayout = (entries, metadata) => {
   // underlying headings with compact anchors / overload flags read just below.
   annotateOverloads(entries);
 
+  const { showReadingTime } = getConfig('jsx-ast');
+
   return createTree('root', [
     createJSXElement(JSX_IMPORTS.Layout.name, {
       metadata,
       headings: extractHeadings(entries),
-      readingTime: readingTime(extractTextContent(entries)).text,
+      readingTime: showReadingTime
+        ? readingTime(extractTextContent(entries)).text
+        : undefined,
       children: entries.map(processEntry),
     }),
   ]);