@waveso/docs 0.6.0 → 0.7.0

package/dist/types.d.ts

@@ -15,6 +15,21 @@ import { StandardSchemaV1 } from "@standard-schema/spec";
  * `Property 'audience' does not exist on type 'DocFrontmatter'` at every read
  * site, because the inference then collapses to this default.
  */
+/**
+ * One call to action in a page's hero.
+ *
+ * `variant` is optional because the shape every landing page has is
+ * primary-then-secondary: the first action is the primary unless it says
+ * otherwise.
+ */
+interface DocAction {
+  /** Visible text. */
+  label: string;
+  /** Where it goes. Internal hrefs route; external ones open in a new tab. */
+  href: string;
+  /** Overrides the position-derived default. */
+  variant?: 'primary' | 'secondary' | undefined;
+}
 interface DocFrontmatter {
   /** Page title. Used for `<h1>` fallbacks, `<title>`, and search. */
   title: string;
@@ -44,6 +59,21 @@ interface DocFrontmatter {
    * Lower sorts first; pages without an order sort last, alphabetically.
    */
   order?: number | undefined;
+  /**
+   * Calls to action, and the opt-in for the page's hero.
+   *
+   * Declaring them turns {@link DocFrontmatter.title} and
+   * {@link DocFrontmatter.description} into a page header with these links
+   * under it, and stops `render` prepending its own `<h1>` — the hero renders
+   * the heading, because the tagline and the actions have to sit beneath it.
+   *
+   * Leave it off and the page is exactly what it was: the description stays a
+   * `<meta>` tag and the title is the first thing in the prose. That is the
+   * whole difference between documentation that is the entire site and
+   * documentation mounted inside an application that already has a landing
+   * page — one field, in the file that wants it.
+   */
+  actions?: DocAction[] | undefined;
 }
 /**
  * A single documentation page discovered on disk.
@@ -450,4 +480,4 @@ interface ResolvedDocsConfig<TFrontmatter extends DocFrontmatter = DocFrontmatte
   frontmatterSchema?: StandardSchemaV1<unknown, TFrontmatter> | undefined;
 }
 //#endregion
-export { DocFile, DocFrontmatter, DocLinkContext, DocNavGroup, DocNavLink, DocNavNode, DocNavPage, DocNavSeparator, DocsConfig, DocsLinkSeverity, DocsMeta, ImageResolver, LinkResolver, RenderedDoc, ResolvedDocsConfig, SearchRecord, TocEntry };
+export { DocAction, 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.6.0",
+  "version": "0.7.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": [
@@ -68,6 +68,10 @@
       "types": "./dist/react/callout.d.ts",
       "default": "./dist/react/callout.js"
     },
+    "./react/hero": {
+      "types": "./dist/react/hero.d.ts",
+      "default": "./dist/react/hero.js"
+    },
     "./react/doc-content": {
       "types": "./dist/react/doc-content.d.ts",
       "default": "./dist/react/doc-content.js"