@mdwrk/mdwrkcom-content-pack 0.1.5

package/data/markdown-topic-matrix.json

@@ -0,0 +1,169 @@
+{
+  "version": 1,
+  "targetCount": {
+    "min": 100,
+    "max": 300
+  },
+  "templates": [
+    { "id": "use-cases", "label": "Use cases", "slug": "use-cases" },
+    { "id": "best-practices", "label": "Best practices", "slug": "best-practices" },
+    { "id": "examples", "label": "Examples", "slug": "examples" },
+    { "id": "benefits", "label": "Benefits", "slug": "benefits" },
+    { "id": "workflow", "label": "Workflow", "slug": "workflow" },
+    { "id": "checklist", "label": "Checklist", "slug": "checklist" },
+    { "id": "for-teams", "label": "For teams", "slug": "for-teams" },
+    { "id": "for-developers", "label": "For developers", "slug": "for-developers" }
+  ],
+  "topics": [
+    {
+      "id": "offline-markdown-editor",
+      "slug": "offline-markdown-editor",
+      "label": "Offline Markdown editor",
+      "summary": "Markdown editing that stays usable without depending on a live hosted authoring backend.",
+      "whyItMatters": "Offline editing helps authors keep writing, previewing, and organizing documents even when a network path is unavailable.",
+      "workflowLine": "Teams use offline Markdown editing for drafts, docs, release notes, note-taking, and review workflows that should not stop when connectivity changes.",
+      "related": ["/answers/what-is-an-offline-markdown-editor/", "/features/", "/compare/local-first-markdown-editors/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "local-first-markdown-workspace",
+      "slug": "local-first-markdown-workspace",
+      "label": "Local-first Markdown workspace",
+      "summary": "A Markdown workspace that keeps normal writing, preview, and organization local by default.",
+      "whyItMatters": "Local-first behavior clarifies what stays on the device and what moves through sync, repository, or publishing workflows.",
+      "workflowLine": "A local-first workspace matters when teams want Markdown to remain durable and usable before networked services enter the flow.",
+      "related": ["/answers/what-is-a-local-first-markdown-workspace/", "/features/", "/trust/privacy-boundary/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-editor",
+      "slug": "markdown-editor",
+      "label": "Markdown editor",
+      "summary": "A writing tool for creating and editing Markdown while keeping the source in plain text.",
+      "whyItMatters": "Markdown editors help authors move between readable source text and rendered output without hiding the underlying format.",
+      "workflowLine": "People evaluate Markdown editors by preview quality, portability, local storage behavior, file organization, and extension surfaces.",
+      "related": ["/markdown/what-is-a-markdown-editor/", "/answers/what-is-an-offline-markdown-editor/", "/packages/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-preview",
+      "slug": "markdown-preview",
+      "label": "Markdown preview",
+      "summary": "Rendered output that helps authors validate Markdown structure while keeping the source visible.",
+      "whyItMatters": "Preview reduces formatting surprises and makes it easier to inspect headings, lists, links, tables, and code blocks while writing.",
+      "workflowLine": "Markdown preview becomes important when teams need confidence that plain-text authoring will render correctly across docs, blogs, and app surfaces.",
+      "related": ["/features/", "/proof/markdown-support/", "/packages/markdown-renderer-core/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-documentation",
+      "slug": "markdown-documentation",
+      "label": "Markdown documentation",
+      "summary": "Documentation workflows built around portable Markdown source files.",
+      "whyItMatters": "Markdown documentation keeps content readable in source form and easier to move through Git, publishing, and review pipelines.",
+      "workflowLine": "Teams use Markdown documentation for developer docs, product guides, internal notes, and public knowledge-base content.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/packages/", "/proof/markdown-support/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-readme",
+      "slug": "markdown-readme",
+      "label": "Markdown README",
+      "summary": "README writing that uses Markdown for project introductions, setup steps, and reference material.",
+      "whyItMatters": "README files are often the first durable documentation surface readers see in a repository or package.",
+      "workflowLine": "A strong Markdown README balances portability, scanability, setup clarity, and enough structure for both humans and crawlers.",
+      "related": ["/markdown/how-to-write-markdown/", "/packages/", "/proof/package-surfaces/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-notes",
+      "slug": "markdown-notes",
+      "label": "Markdown notes",
+      "summary": "Plain-text note-taking workflows built around Markdown structure and portability.",
+      "whyItMatters": "Markdown notes help people keep information readable, linkable, and portable across tools and devices.",
+      "workflowLine": "Teams use Markdown notes for meeting notes, design notes, release notes, learning logs, and lightweight knowledge capture.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/answers/what-is-an-offline-markdown-editor/", "/features/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-blogging",
+      "slug": "markdown-blogging",
+      "label": "Markdown blogging",
+      "summary": "Writing and publishing blog content from Markdown source files.",
+      "whyItMatters": "Markdown blogging keeps the authoring source small, portable, and easier to move through publishing pipelines.",
+      "workflowLine": "Markdown blogging matters when writers want simple formatting, code blocks, reusable content structures, and easier versioning.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/markdown/how-to-write-markdown/", "/proof/markdown-support/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-knowledge-base",
+      "slug": "markdown-knowledge-base",
+      "label": "Markdown knowledge base",
+      "summary": "Knowledge-base content managed through Markdown documents and structured navigation.",
+      "whyItMatters": "Markdown knowledge bases can stay portable while still supporting searchable, linked, and versioned documentation.",
+      "workflowLine": "Teams use Markdown knowledge bases when they need durable docs that can move between site generators, repos, and internal tools.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/answers/", "/features/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-project-docs",
+      "slug": "markdown-project-docs",
+      "label": "Markdown project docs",
+      "summary": "Project documentation organized through Markdown pages, README files, and linked reference content.",
+      "whyItMatters": "Project docs need plain-text durability, easy review, version control, and predictable rendering across teams.",
+      "workflowLine": "Markdown project docs help teams keep setup, architecture, release, and troubleshooting information close to the code.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/packages/", "/proof/package-surfaces/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-writing-workflow",
+      "slug": "markdown-writing-workflow",
+      "label": "Markdown writing workflow",
+      "summary": "A repeatable writing flow built around Markdown source, preview, review, and publishing steps.",
+      "whyItMatters": "A clear Markdown workflow helps authors move from draft to published output without losing source portability.",
+      "workflowLine": "Markdown writing workflows usually combine authoring, preview, revision, file organization, and output-specific publishing checks.",
+      "related": ["/markdown/how-to-write-markdown/", "/answers/", "/features/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-for-teams",
+      "slug": "markdown-for-teams",
+      "label": "Markdown for teams",
+      "summary": "Team documentation and writing workflows that use Markdown as the common source format.",
+      "whyItMatters": "Teams need content that stays readable in source form while still working in review, publishing, and collaboration systems.",
+      "workflowLine": "Markdown for teams is often evaluated through file ownership, review processes, portability, preview fidelity, and publishing confidence.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/answers/does-mdwrk-require-a-server/", "/trust/privacy-boundary/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-for-developers",
+      "slug": "markdown-for-developers",
+      "label": "Markdown for developers",
+      "summary": "Markdown workflows shaped around code, docs, review, and repository collaboration.",
+      "whyItMatters": "Developers use Markdown because it stays close to code, version control, and plain-text review workflows.",
+      "workflowLine": "Markdown for developers typically connects README files, architecture docs, issue notes, release notes, and rendered package or site output.",
+      "related": ["/markdown/what-is-markdown-used-for/", "/packages/markdown-renderer-core/", "/proof/package-surfaces/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-theme-packs",
+      "slug": "markdown-theme-packs",
+      "label": "Markdown theme packs",
+      "summary": "Theme surfaces that style Markdown authoring and preview experiences through governed contracts.",
+      "whyItMatters": "Theme packs separate visual identity from content structure and rendering behavior.",
+      "workflowLine": "Markdown theme-pack work matters when teams need consistent styling across editor, preview, and public lander surfaces without patching internals.",
+      "related": ["/answers/how-do-mdwrk-theme-packs-work/", "/packages/theme-contract/", "/packages/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    },
+    {
+      "id": "markdown-extension-workflows",
+      "slug": "markdown-extension-workflows",
+      "label": "Markdown extension workflows",
+      "summary": "Extension-oriented workflows that add commands, panes, integrations, or automation around Markdown.",
+      "whyItMatters": "Extension workflows matter when teams want customization without turning every Markdown behavior into app-local code.",
+      "workflowLine": "Markdown extension work is easier to scale when commands, settings, and runtime behavior are documented and reusable.",
+      "related": ["/packages/extension-runtime/", "/packages/", "/answers/how-do-mdwrk-theme-packs-work/"],
+      "templates": ["use-cases", "best-practices", "examples", "benefits", "workflow", "checklist", "for-teams", "for-developers"]
+    }
+  ]
+}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import type { ComponentIntentSpec, StructuredDataIntentSpec } from "@mdwrk/lander-content-contract";
+import { MDWRKCOM_CONTENT_PACK_VERSION } from "./version.js";
+export { MDWRKCOM_CONTENT_PACK_VERSION };
+export interface MdwrkcomContentPackLayout {
+    packageName: string;
+    version: string;
+    sourceContentRoot: "content";
+    markdownDataRoot: "data/markdown";
+    sitemapPath: "data/content-sitemap.yaml";
+    publicAssetRoot: "public";
+    generatedArtifactRoot: "generated";
+    generatedArtifacts: readonly string[];
+}
+export interface MdwrkcomLanderRenderingIntent {
+    contentPack: typeof MDWRKCOM_CONTENT_PACK_NAME;
+    contractPackage: "@mdwrk/lander-content-contract";
+    compilerPackage: "@mdwrk/lander-core";
+    rendererPackage: "@mdwrk/lander-react";
+    componentIntents: readonly ComponentIntentSpec[];
+    schemaIntents: readonly StructuredDataIntentSpec[];
+}
+export declare const MDWRKCOM_CONTENT_PACK_NAME = "@mdwrk/mdwrkcom-content-pack";
+export declare const mdwrkcomContentPack: MdwrkcomContentPackLayout;
+export declare const mdwrkcomLanderRenderingIntent: MdwrkcomLanderRenderingIntent;
+export declare function resolveMdwrkcomContentPackPath(pathInPack: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AACpG,OAAO,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,6BAA6B,EAAE,CAAC;AAEzC,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,SAAS,CAAC;IAC7B,gBAAgB,EAAE,eAAe,CAAC;IAClC,WAAW,EAAE,2BAA2B,CAAC;IACzC,eAAe,EAAE,QAAQ,CAAC;IAC1B,qBAAqB,EAAE,WAAW,CAAC;IACnC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,6BAA6B;IAC5C,WAAW,EAAE,OAAO,0BAA0B,CAAC;IAC/C,eAAe,EAAE,gCAAgC,CAAC;IAClD,eAAe,EAAE,oBAAoB,CAAC;IACtC,eAAe,EAAE,qBAAqB,CAAC;IACvC,gBAAgB,EAAE,SAAS,mBAAmB,EAAE,CAAC;IACjD,aAAa,EAAE,SAAS,wBAAwB,EAAE,CAAC;CACpD;AAED,eAAO,MAAM,0BAA0B,iCAAiC,CAAC;AAEzE,eAAO,MAAM,mBAAmB,EAAE,yBAoBhC,CAAC;AAEH,eAAO,MAAM,6BAA6B,EAAE,6BAoB1C,CAAC;AAEH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAEzE"}

package/dist/index.js

@@ -0,0 +1,49 @@
+import { MDWRKCOM_CONTENT_PACK_VERSION } from "./version.js";
+export { MDWRKCOM_CONTENT_PACK_VERSION };
+export const MDWRKCOM_CONTENT_PACK_NAME = "@mdwrk/mdwrkcom-content-pack";
+export const mdwrkcomContentPack = Object.freeze({
+    packageName: MDWRKCOM_CONTENT_PACK_NAME,
+    version: MDWRKCOM_CONTENT_PACK_VERSION,
+    sourceContentRoot: "content",
+    markdownDataRoot: "data/markdown",
+    sitemapPath: "data/content-sitemap.yaml",
+    publicAssetRoot: "public",
+    generatedArtifactRoot: "generated",
+    generatedArtifacts: Object.freeze([
+        "content-index.json",
+        "content-registry.json",
+        "cache-header-manifest.json",
+        "jsonld-graph.json",
+        "llms.txt",
+        "llms-full.txt",
+        "robots.txt",
+        "sitemap.xml",
+        "sitemap.xsl",
+        "semantic-index.json",
+    ]),
+});
+export const mdwrkcomLanderRenderingIntent = Object.freeze({
+    contentPack: MDWRKCOM_CONTENT_PACK_NAME,
+    contractPackage: "@mdwrk/lander-content-contract",
+    compilerPackage: "@mdwrk/lander-core",
+    rendererPackage: "@mdwrk/lander-react",
+    componentIntents: Object.freeze([
+        { id: "mdwrkcom:page-shell", kind: "page_shell", sourceId: "mdwrkcom" },
+        { id: "mdwrkcom:breadcrumbs", kind: "breadcrumbs", sourceId: "mdwrkcom" },
+        { id: "mdwrkcom:hero", kind: "hero", sourceId: "mdwrkcom.sections.hero" },
+        { id: "mdwrkcom:feature-grid", kind: "feature_grid", sourceId: "mdwrkcom.sections.feature_grid" },
+        { id: "mdwrkcom:structured-data-graph", kind: "structured_data_graph", sourceId: "mdwrkcom.schema" },
+    ]),
+    schemaIntents: Object.freeze([
+        { id: "mdwrkcom:schema-software-application", kind: "SoftwareApplication" },
+        { id: "mdwrkcom:schema-website", kind: "WebSite" },
+        { id: "mdwrkcom:schema-faq-page", kind: "FAQPage" },
+        { id: "mdwrkcom:schema-tech-article", kind: "TechArticle" },
+        { id: "mdwrkcom:schema-item-list", kind: "ItemList" },
+        { id: "mdwrkcom:schema-software-source-code", kind: "SoftwareSourceCode" },
+    ]),
+});
+export function resolveMdwrkcomContentPackPath(pathInPack) {
+    return new URL(`../${pathInPack.replace(/^\/+/, "")}`, import.meta.url).pathname;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,6BAA6B,EAAE,CAAC;AAsBzC,MAAM,CAAC,MAAM,0BAA0B,GAAG,8BAA8B,CAAC;AAEzE,MAAM,CAAC,MAAM,mBAAmB,GAA8B,MAAM,CAAC,MAAM,CAAC;IAC1E,WAAW,EAAE,0BAA0B;IACvC,OAAO,EAAE,6BAA6B;IACtC,iBAAiB,EAAE,SAAS;IAC5B,gBAAgB,EAAE,eAAe;IACjC,WAAW,EAAE,2BAA2B;IACxC,eAAe,EAAE,QAAQ;IACzB,qBAAqB,EAAE,WAAW;IAClC,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC;QAChC,oBAAoB;QACpB,uBAAuB;QACvB,4BAA4B;QAC5B,mBAAmB;QACnB,UAAU;QACV,eAAe;QACf,YAAY;QACZ,aAAa;QACb,aAAa;QACb,qBAAqB;KACtB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAkC,MAAM,CAAC,MAAM,CAAC;IACxF,WAAW,EAAE,0BAA0B;IACvC,eAAe,EAAE,gCAAgC;IACjD,eAAe,EAAE,oBAAoB;IACrC,eAAe,EAAE,qBAAqB;IACtC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC;QAC9B,EAAE,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE;QACvE,EAAE,EAAE,EAAE,sBAAsB,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE;QACzE,EAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,wBAAwB,EAAE;QACzE,EAAE,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,gCAAgC,EAAE;QACjG,EAAE,EAAE,EAAE,gCAAgC,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,iBAAiB,EAAE;KACrE,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC;QAC3B,EAAE,EAAE,EAAE,sCAAsC,EAAE,IAAI,EAAE,qBAAqB,EAAE;QAC3E,EAAE,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE,SAAS,EAAE;QAClD,EAAE,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,SAAS,EAAE;QACnD,EAAE,EAAE,EAAE,8BAA8B,EAAE,IAAI,EAAE,aAAa,EAAE;QAC3D,EAAE,EAAE,EAAE,2BAA2B,EAAE,IAAI,EAAE,UAAU,EAAE;QACrD,EAAE,EAAE,EAAE,sCAAsC,EAAE,IAAI,EAAE,oBAAoB,EAAE;KACtC,CAAC;CACxC,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAAC,UAAkB;IAC/D,OAAO,IAAI,GAAG,CAAC,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;AACnF,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const MDWRKCOM_CONTENT_PACK_VERSION = "0.1.4";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,UAAU,CAAC"}

package/dist/version.js

@@ -0,0 +1,2 @@
+export const MDWRKCOM_CONTENT_PACK_VERSION = "0.1.4";
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,6BAA6B,GAAG,OAAO,CAAC"}