docmedown 0.1.6 → 0.1.7

package/dist/types/runtime/components/OfflineNotice.d.ts

@@ -0,0 +1,6 @@
+import type React from "react";
+/**
+ * Startup notice for self-contained offline copies: a dismissible toast that
+ * expands into a modal describing exactly what the copy can and cannot do.
+ */
+export declare const OfflineNotice: React.FC;

package/dist/types/runtime/config-schema.d.ts

@@ -137,6 +137,9 @@ export declare const docSearchConfigSchema: z.ZodObject<{
     placeholder: z.ZodOptional<z.ZodString>;
     maxResults: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>;
+export declare const docOfflineConfigSchema: z.ZodObject<{
+    embedNestedDocs: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
 /**
  * Schema for unmerged user configuration. It intentionally keeps `name` optional
  * because callers may provide a partial override that inherits the default name.
@@ -247,6 +250,9 @@ export declare const docConfigSchema: z.ZodObject<{
         placeholder: z.ZodOptional<z.ZodString>;
         maxResults: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>;
+    offline: z.ZodOptional<z.ZodObject<{
+        embedNestedDocs: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
     footer: z.ZodOptional<z.ZodObject<{
         copyright: z.ZodOptional<z.ZodString>;
         links: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -366,6 +372,9 @@ export declare const normalizedDocConfigSchema: z.ZodObject<{
         placeholder: z.ZodOptional<z.ZodString>;
         maxResults: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>;
+    offline: z.ZodOptional<z.ZodObject<{
+        embedNestedDocs: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
     footer: z.ZodOptional<z.ZodObject<{
         copyright: z.ZodOptional<z.ZodString>;
         links: z.ZodOptional<z.ZodArray<z.ZodObject<{

package/dist/types/runtime/markdown/inline-text.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Plain-text conversion for document headings.
+ *
+ * README-style headings routinely carry badge images, inline code, links, and
+ * HTML entities. The page map renders the full inline HTML (from the same
+ * pipeline as article headings), while search indexing, document titles, and
+ * accessibility strings need the readable plain-text form produced here.
+ */
+export declare function decodeHtmlEntities(value: string): string;
+/** Reduces a heading's raw Markdown to readable plain text. */
+export declare function inlineHeadingToPlainText(raw: string): string;

package/dist/types/runtime/offline-export.d.ts

@@ -5,7 +5,17 @@ export interface OfflineDocumentationData {
     manifest: DocManifest;
     docs: Record<string, string>;
     componentsSource?: string;
+    nestedSites?: Record<string, OfflineNestedSiteData>;
 }
+/** A nested documentation root embedded inside a parent offline bundle. */
+export interface OfflineNestedSiteData {
+    name: string;
+    manifest: DocManifest;
+    docs: Record<string, string>;
+    componentsSource?: string;
+}
+/** Emitted when a reader selects a file link a self-contained copy cannot fulfill. */
+export declare const OFFLINE_LINK_EVENT = "docmedown:offline-link-unavailable";
 export interface OfflineEnvelope {
     version: number;
     data: OfflineDocumentationData;
@@ -13,6 +23,9 @@ export interface OfflineEnvelope {
 }
 export declare function sanitizeDownloadName(name: string): string;
 export declare function isOfflineDocumentation(): boolean;
+/** True only for self-contained single-file copies, not the serveable site under file://. */
+export declare function isSelfContainedOffline(): boolean;
+export declare function notifyUnavailableOfflineLink(message?: string): void;
 /**
  * Generates the tiny self-extracting HTML shell shared by CLI and browser
  * exporters. The payload is a base64-encoded gzip stream containing compact
@@ -24,3 +37,15 @@ export declare function createOfflineDownload(): Promise<{
     filename: string;
 }>;
 export declare function downloadOfflineCopy(): Promise<void>;
+export declare function getEmbeddedNestedSites(): Record<string, OfflineNestedSiteData> | null;
+/** True for relative links to other HTML files; hash routes and remote URLs are excluded. */
+export declare function isRelativeHtmlLink(href: string): boolean;
+/** Maps a clicked file link onto an embedded nested documentation site, if any. */
+export declare function matchEmbeddedNestedSite(href: string, sites: Record<string, OfflineNestedSiteData> | null | undefined): string | null;
+/**
+ * Opens an embedded nested documentation site from inside a self-contained
+ * offline copy. The nested site is rebuilt in memory as its own
+ * self-extracting page and opened from a blob URL, so no external file or
+ * relative link is ever required.
+ */
+export declare function openEmbeddedNestedSite(siteKey: string, href?: string): Promise<void>;

package/dist/types/runtime/types.d.ts

@@ -36,7 +36,10 @@ export interface DocMeDownInstance {
 }
 export interface DocHeading {
     level: number;
+    /** Readable plain text (badges become alt text; entities decoded) for search and titles. */
     text: string;
+    /** Inline-rendered Markdown for display; omitted in manifest-only heading sets. */
+    html?: string;
     id: string;
 }
 export interface DocFrontmatter {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docmedown",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "The simplest MarkDown documenter yet. CLI & Web Script React SPA documentation engine.",
   "main": "./dist/docmedown.cjs",
   "module": "./dist/docmedown.mjs",

package/schemas/docs.schema.json

@@ -24,6 +24,7 @@
     "sidebar": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } },
     "autoIndex": { "$ref": "#/$defs/autoIndex" },
     "search": { "$ref": "#/$defs/search" },
+    "offline": { "$ref": "#/$defs/offline" },
     "footer": { "$ref": "#/$defs/footer" },
     "componentsUrl": { "type": "string" },
     "editUrl": { "type": "string" }
@@ -144,6 +145,16 @@
         "maxResults": { "type": "integer", "minimum": 1, "maximum": 100 }
       }
     },
+    "offline": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "embedNestedDocs": {
+          "type": "boolean",
+          "description": "Embed nested documentation sites into the single-file offline bundle so no external files are needed. Defaults to true; when false, links to other documentation files render as disabled links offline."
+        }
+      }
+    },
     "footer": {
       "type": "object",
       "additionalProperties": false,

package/templates/docs.json

@@ -25,5 +25,8 @@
   "search": {
     "enabled": true,
     "placeholder": "Search documentation..."
+  },
+  "offline": {
+    "embedNestedDocs": true
   }
 }