@waveso/docs 0.10.0 → 0.12.0

package/dist/types.d.ts

@@ -59,6 +59,19 @@ interface DocFrontmatter {
    * Lower sorts first; pages without an order sort last, alphabetically.
    */
   order?: number | undefined;
+  /**
+   * "Where to go next": a question, and the page that answers it.
+   *
+   * Declaring it renders a block at the foot of the page, above the pager. The
+   * two are not the same thing and both belong there — this is the *semantic*
+   * answer ("what do you want to know?"), the pager is the *linear* one ("what
+   * comes after this page?").
+   *
+   * A table would do the same job and does it worse: a screen reader announces
+   * "table, 2 columns, 7 rows" for what is a list of links with descriptions,
+   * and two columns of sentence-length questions are cramped on a phone.
+   */
+  explore?: DocExploreLink[] | undefined;
   /**
    * Sidebar marker for this page, as a name the *consumer* resolves.
    *
@@ -130,6 +143,23 @@ interface DocFile<TFrontmatter extends DocFrontmatter = DocFrontmatter> {
    */
   frontmatterLines?: number | undefined;
 }
+/**
+ * One row of a page's "where to go next" block.
+ *
+ * ⚠️ `title` IS OPTIONAL BECAUSE THE NAVIGATION ALREADY KNOWS IT. An `href`
+ * pointing at a page in the tree takes that page's own name, so renaming it
+ * updates every block that points at it — the same reasoning as the pager's
+ * ordering. Name it here only where the tree cannot answer: an external link,
+ * or a page kept out of the navigation.
+ */
+interface DocExploreLink {
+  /** What the reader might want to know. The row's left half. */
+  question: string;
+  /** Where the answer is. */
+  href: string;
+  /** The link's text. Defaults to the destination's title in the navigation. */
+  title?: string | undefined;
+}
 /** A link to a documentation page. */
 interface DocNavPage {
   type: 'page';
@@ -507,4 +537,4 @@ interface ResolvedDocsConfig<TFrontmatter extends DocFrontmatter = DocFrontmatte
   frontmatterSchema?: StandardSchemaV1<unknown, TFrontmatter> | undefined;
 }
 //#endregion
-export { DocAction, DocFile, DocFrontmatter, DocLinkContext, DocNavGroup, DocNavLink, DocNavNode, DocNavPage, DocNavSeparator, DocsConfig, DocsLinkSeverity, DocsMeta, ImageResolver, LinkResolver, RenderedDoc, ResolvedDocsConfig, SearchRecord, TocEntry };
+export { DocAction, DocExploreLink, DocFile, DocFrontmatter, DocLinkContext, DocNavGroup, DocNavLink, DocNavNode, DocNavPage, DocNavSeparator, DocsConfig, DocsLinkSeverity, DocsMeta, ImageResolver, LinkResolver, RenderedDoc, ResolvedDocsConfig, SearchRecord, TocEntry };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waveso/docs",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Zero parser bytes in the browser: markdown docs for Next.js, built to hast in Node and rendered as your components",
   "type": "module",
   "sideEffects": [
@@ -111,6 +111,10 @@
     "./react/pager": {
       "types": "./dist/react/pager.d.ts",
       "default": "./dist/react/pager.js"
+    },
+    "./react/explore": {
+      "types": "./dist/react/explore.d.ts",
+      "default": "./dist/react/explore.js"
     }
   },
   "files": [