@offorte/show-doc 0.0.1

package/dist/types/components/shw-badge.d.ts

@@ -0,0 +1,25 @@
+import { LitElement } from "lit";
+import type { ShwTone } from "../shw-tone";
+/**
+ * Shows a short status or category label.
+ *
+ * @element shw-badge
+ * @slot - Short status or category text.
+ */
+export declare class ShwBadge extends LitElement {
+    static properties: {
+        tone: {
+            type: StringConstructor;
+            reflect: boolean;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Visual meaning of the badge. */
+    tone: ShwTone;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-badge": ShwBadge;
+    }
+}

package/dist/types/components/shw-callout.d.ts

@@ -0,0 +1,31 @@
+import { LitElement } from "lit";
+import type { ShwTone } from "../shw-tone";
+import "./shw-markdown";
+/**
+ * Highlights a short Markdown message.
+ *
+ * @element shw-callout
+ */
+export declare class ShwCallout extends LitElement {
+    #private;
+    static properties: {
+        heading: {
+            type: StringConstructor;
+        };
+        tone: {
+            type: StringConstructor;
+            reflect: boolean;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional callout heading. */
+    heading: string;
+    /** Visual meaning of the callout. */
+    tone: ShwTone;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-callout": ShwCallout;
+    }
+}

package/dist/types/components/shw-card.d.ts

@@ -0,0 +1,37 @@
+import { LitElement } from "lit";
+import type { ShwTone } from "../shw-tone";
+import "./shw-badge";
+import "./shw-markdown";
+/**
+ * Groups one focused idea in a bordered card with an optional badge.
+ *
+ * @element shw-card
+ */
+export declare class ShwCard extends LitElement {
+    #private;
+    static properties: {
+        heading: {
+            type: StringConstructor;
+        };
+        label: {
+            type: StringConstructor;
+        };
+        tone: {
+            type: StringConstructor;
+            reflect: boolean;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional card heading. */
+    heading: string;
+    /** Optional short badge label above the heading. */
+    label: string;
+    /** Visual meaning of the optional badge. */
+    tone: ShwTone;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-card": ShwCard;
+    }
+}

package/dist/types/components/shw-code.d.ts

@@ -0,0 +1,28 @@
+import { LitElement } from "lit";
+/**
+ * Shows a syntax-highlighted code block with an optional filename.
+ *
+ * @element shw-code
+ */
+export declare class ShwCode extends LitElement {
+    #private;
+    static properties: {
+        filename: {
+            type: StringConstructor;
+        };
+        language: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional filename shown above the code. */
+    filename: string;
+    /** Syntax language. Supported values are html, js, ts, and json. */
+    language: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-code": ShwCode;
+    }
+}

package/dist/types/components/shw-collapsible.d.ts

@@ -0,0 +1,30 @@
+import { LitElement } from "lit";
+import "./shw-markdown";
+/**
+ * Hides optional Markdown details behind a native disclosure control.
+ *
+ * @element shw-collapsible
+ */
+export declare class ShwCollapsible extends LitElement {
+    #private;
+    static properties: {
+        open: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
+        summary: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Whether the disclosure starts open. */
+    open: boolean;
+    /** Label for the disclosure control. */
+    summary: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-collapsible": ShwCollapsible;
+    }
+}

package/dist/types/components/shw-doc.d.ts

@@ -0,0 +1,16 @@
+import { LitElement } from "lit";
+/**
+ * Provides the page and document canvas for a ShowDoc artifact.
+ *
+ * @element shw-doc
+ * @slot - The complete visible document.
+ */
+export declare class ShwDoc extends LitElement {
+    static styles: import("lit").CSSResult[];
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-doc": ShwDoc;
+    }
+}

package/dist/types/components/shw-figure.d.ts

@@ -0,0 +1,23 @@
+import { LitElement } from "lit";
+/**
+ * Frames an image, SVG, or diagram with an optional caption.
+ *
+ * @element shw-figure
+ * @slot - The image, SVG, or diagram.
+ */
+export declare class ShwFigure extends LitElement {
+    static properties: {
+        caption: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional plain-text caption below the visual. */
+    caption: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-figure": ShwFigure;
+    }
+}

package/dist/types/components/shw-grid.d.ts

@@ -0,0 +1,24 @@
+import { LitElement } from "lit";
+/**
+ * Arranges child blocks in one to four responsive columns.
+ *
+ * @element shw-grid
+ * @slot - The blocks arranged by the grid.
+ */
+export declare class ShwGrid extends LitElement {
+    static properties: {
+        columns: {
+            type: NumberConstructor;
+            reflect: boolean;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Number of columns. Supported values are 1, 2, 3, and 4. */
+    columns: 1 | 2 | 3 | 4;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-grid": ShwGrid;
+    }
+}

package/dist/types/components/shw-header.d.ts

@@ -0,0 +1,29 @@
+import { LitElement } from "lit";
+import "./shw-markdown";
+/**
+ * Renders a document title and an optional Markdown introduction.
+ *
+ * @element shw-header
+ */
+export declare class ShwHeader extends LitElement {
+    #private;
+    static properties: {
+        eyebrow: {
+            type: StringConstructor;
+        };
+        heading: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Short label above the main heading. */
+    eyebrow: string;
+    /** Main document heading. */
+    heading: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-header": ShwHeader;
+    }
+}

package/dist/types/components/shw-markdown.d.ts

@@ -0,0 +1,16 @@
+import { LitElement, nothing } from "lit";
+/**
+ * Renders safe CommonMark from its light DOM text.
+ *
+ * @element shw-markdown
+ */
+export declare class ShwMarkdown extends LitElement {
+    #private;
+    static styles: import("lit").CSSResult[];
+    protected render(): typeof nothing | import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-markdown": ShwMarkdown;
+    }
+}

package/dist/types/components/shw-mermaid.d.ts

@@ -0,0 +1,26 @@
+import { LitElement } from "lit";
+/**
+ * Renders Mermaid source as a responsive diagram.
+ *
+ * @element shw-mermaid
+ */
+export declare class ShwMermaid extends LitElement {
+    #private;
+    static properties: {
+        label: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Accessible name for the rendered diagram. */
+    label: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected render(): import("lit").TemplateResult<1>;
+    protected updated(): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-mermaid": ShwMermaid;
+    }
+}

package/dist/types/components/shw-section.d.ts

@@ -0,0 +1,34 @@
+import { LitElement } from "lit";
+/**
+ * Groups related document blocks under a heading divider and optional short introduction.
+ *
+ * @element shw-section
+ * @slot - The document blocks in the section.
+ */
+export declare class ShwSection extends LitElement {
+    #private;
+    static properties: {
+        heading: {
+            type: StringConstructor;
+        };
+        intro: {
+            type: StringConstructor;
+        };
+        level: {
+            type: NumberConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional section heading. */
+    heading: string;
+    /** Optional short context beside the section heading. */
+    intro: string;
+    /** Heading level. Supported values are 2 and 3. */
+    level: 2 | 3;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-section": ShwSection;
+    }
+}

package/dist/types/components/shw-stat.d.ts

@@ -0,0 +1,39 @@
+import { LitElement } from "lit";
+import type { ShwTone } from "../shw-tone";
+/**
+ * Shows one prominent value with a label and optional change.
+ *
+ * @element shw-stat
+ */
+export declare class ShwStat extends LitElement {
+    static properties: {
+        change: {
+            type: StringConstructor;
+        };
+        label: {
+            type: StringConstructor;
+        };
+        tone: {
+            type: StringConstructor;
+            reflect: boolean;
+        };
+        value: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional short change or context below the value. */
+    change: string;
+    /** Short description of the value. */
+    label: string;
+    /** Visual meaning of the change. */
+    tone: ShwTone;
+    /** Prominent value. */
+    value: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-stat": ShwStat;
+    }
+}

package/dist/types/components/shw-steps.d.ts

@@ -0,0 +1,17 @@
+import { LitElement } from "lit";
+import "./shw-markdown";
+/**
+ * Turns a compact numbered Markdown list into a visual sequence.
+ *
+ * @element shw-steps
+ */
+export declare class ShwSteps extends LitElement {
+    #private;
+    static styles: import("lit").CSSResult[];
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-steps": ShwSteps;
+    }
+}

package/dist/types/components/shw-summary.d.ts

@@ -0,0 +1,24 @@
+import { LitElement } from "lit";
+import "./shw-markdown";
+/**
+ * Presents a short Markdown overview before the document details.
+ *
+ * @element shw-summary
+ */
+export declare class ShwSummary extends LitElement {
+    #private;
+    static properties: {
+        heading: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Short label above the overview. */
+    heading: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-summary": ShwSummary;
+    }
+}

package/dist/types/components/shw-table.d.ts

@@ -0,0 +1,23 @@
+import { LitElement } from "lit";
+/**
+ * Renders pipe-separated light DOM text as a semantic table.
+ *
+ * @element shw-table
+ */
+export declare class ShwTable extends LitElement {
+    #private;
+    static properties: {
+        caption: {
+            type: StringConstructor;
+        };
+    };
+    static styles: import("lit").CSSResult[];
+    /** Optional accessible table caption. */
+    caption: string;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "shw-table": ShwTable;
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export { ShwBadge } from "./components/shw-badge";
+export { ShwCallout } from "./components/shw-callout";
+export { ShwCard } from "./components/shw-card";
+export { ShwCollapsible } from "./components/shw-collapsible";
+export { ShwCode } from "./components/shw-code";
+export { ShwDoc } from "./components/shw-doc";
+export { ShwFigure } from "./components/shw-figure";
+export { ShwGrid } from "./components/shw-grid";
+export { ShwHeader } from "./components/shw-header";
+export { ShwMarkdown } from "./components/shw-markdown";
+export { ShwSection } from "./components/shw-section";
+export { ShwStat } from "./components/shw-stat";
+export { ShwSteps } from "./components/shw-steps";
+export { ShwSummary } from "./components/shw-summary";
+export { ShwTable } from "./components/shw-table";
+export type { ShwTone } from "./shw-tone";

package/dist/types/mermaid.d.ts

@@ -0,0 +1,2 @@
+export * from "./index";
+export { ShwMermaid } from "./components/shw-mermaid";

package/dist/types/shw-tone.d.ts

@@ -0,0 +1 @@
+export type ShwTone = "info" | "success" | "warning" | "danger" | "neutral";

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@offorte/show-doc",
+  "version": "0.0.1",
+  "description": "Agent skill and web components for polished, human-readable HTML documents.",
+  "keywords": [
+    "documentation",
+    "html-artifacts",
+    "lit",
+    "markdown",
+    "tailwindcss",
+    "web-components"
+  ],
+  "homepage": "https://github.com/offorte/show-doc#readme",
+  "bugs": {
+    "url": "https://github.com/offorte/show-doc/issues"
+  },
+  "license": "MIT",
+  "author": "Offorte",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/offorte/show-doc.git"
+  },
+  "files": [
+    "dist/THIRD_PARTY_LICENSES.md",
+    "dist/showdoc.js",
+    "dist/showdoc-mermaid.js",
+    "dist/types/components",
+    "dist/types/index.d.ts",
+    "dist/types/mermaid.d.ts",
+    "dist/types/shw-tone.d.ts",
+    "custom-elements.json",
+    "skills",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": [
+    "./dist/showdoc.js",
+    "./dist/showdoc-mermaid.js"
+  ],
+  "main": "./dist/showdoc.js",
+  "module": "./dist/showdoc.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/showdoc.js"
+    },
+    "./mermaid": {
+      "types": "./dist/types/mermaid.d.ts",
+      "import": "./dist/showdoc-mermaid.js"
+    },
+    "./custom-elements.json": "./custom-elements.json",
+    "./skill": "./skills/show-doc/SKILL.md"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite --host 127.0.0.1",
+    "serve": "pnpm build && node scripts/prepare-preview.mjs && vite preview --host 127.0.0.1 --port 4173 --strictPort --outDir .preview",
+    "build": "vite build && vite build --mode mermaid && tsc -p tsconfig.build.json",
+    "check:build": "node scripts/check-build.mjs",
+    "check:package": "node scripts/check-package.mjs",
+    "manifest": "cem analyze --litelement --globs \"src/components/*.ts\"",
+    "manifest:check": "pnpm manifest && node scripts/check-manifest.mjs",
+    "lint": "oxlint src test scripts vite.config.ts web-test-runner.config.mjs custom-elements-manifest.config.mjs",
+    "format": "oxfmt . --write --ignore-path .oxfmtignore",
+    "format:check": "oxfmt . --check --ignore-path .oxfmtignore",
+    "typecheck": "tsc --noEmit",
+    "test": "pnpm build && pnpm test:browser",
+    "test:browser": "web-test-runner \"test/**/*.test.js\" --config web-test-runner.config.mjs",
+    "fallow:check": "fallow --format compact --fail-on-issues --summary",
+    "verify:source": "pnpm format:check && pnpm lint && pnpm typecheck",
+    "verify:build": "pnpm test:browser && pnpm manifest:check && pnpm check:build && pnpm check:package && pnpm fallow:check",
+    "agent:verify": "pnpm verify:source && pnpm build && pnpm verify:build",
+    "prepack": "pnpm build && pnpm manifest:check && pnpm check:build && pnpm check:package"
+  },
+  "dependencies": {
+    "lit": "3.3.3"
+  },
+  "devDependencies": {
+    "@custom-elements-manifest/analyzer": "0.11.0",
+    "@open-wc/testing": "5.0.0",
+    "@tailwindcss/typography": "0.5.20",
+    "@tailwindcss/vite": "4.3.3",
+    "@types/node": "26.3.0",
+    "@types/prismjs": "1.26.6",
+    "@web/test-runner": "1.0.0",
+    "@web/test-runner-playwright": "1.0.0",
+    "fallow": "3.18.0",
+    "mermaid": "11.17.2",
+    "micromark": "4.0.2",
+    "micromark-extension-gfm-strikethrough": "2.1.0",
+    "micromark-extension-gfm-task-list-item": "2.1.0",
+    "oxfmt": "0.65.0",
+    "oxlint": "1.80.0",
+    "playwright": "1.62.1",
+    "prismjs": "1.30.0",
+    "tailwindcss": "4.3.3",
+    "typescript": "7.0.2",
+    "vite": "8.2.2"
+  },
+  "packageManager": "pnpm@10.30.0",
+  "customElements": "custom-elements.json"
+}