@zpress/kit 0.1.1 → 0.1.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Joggr
+Copyright (c) 2026 Joggr, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,79 @@
+<div align="center">
+  <img src="https://raw.githubusercontent.com/joggrdocs/zpress/main/assets/banner.svg" alt="zpress" width="90%" />
+  <p><strong>An opinionated documentation framework for monorepos. Just point it at your code.</strong></p>
+
+<a href="https://github.com/joggrdocs/zpress/actions/workflows/ci.yml"><img src="https://github.com/joggrdocs/zpress/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
+<a href="https://www.npmjs.com/package/@zpress/kit"><img src="https://img.shields.io/npm/v/@zpress/kit" alt="npm version" /></a>
+<a href="https://github.com/joggrdocs/zpress/blob/main/LICENSE"><img src="https://img.shields.io/github/license/joggrdocs/zpress" alt="License" /></a>
+
+</div>
+
+## Features
+
+- :gear: **Config over convention** — Define sections, pages, and nav in one declarative config.
+- :zap: **Zero-config defaults** — Smart conventions for sidebars, nav, icons, and landing pages.
+- :package: **Monorepo-native** — Workspace metadata with auto-generated package cards.
+- :mag: **Auto-discovery** — Glob patterns to find and organize markdown files.
+- :art: **Beautiful out of the box** — Catppuccin-themed UI with responsive layouts.
+
+## Install
+
+```bash
+npm install @zpress/kit
+```
+
+## Usage
+
+### Define your docs
+
+```ts
+// zpress.config.ts
+import { defineConfig } from '@zpress/kit'
+
+export default defineConfig({
+  title: 'my-project',
+  description: 'Internal developer docs',
+  sections: [
+    {
+      text: 'Getting Started',
+      link: '/getting-started',
+      from: 'docs/getting-started.md',
+      icon: 'pixelarticons:speed-fast',
+    },
+    {
+      text: 'Guides',
+      prefix: '/guides',
+      icon: 'pixelarticons:book-open',
+      from: 'docs/guides/*.md',
+      textFrom: 'heading',
+      sort: 'alpha',
+    },
+  ],
+  nav: 'auto',
+})
+```
+
+### Run it
+
+```bash
+npx zpress dev       # start dev server with hot reload
+npx zpress build     # build for production
+npx zpress serve     # preview production build
+```
+
+## Packages
+
+| Package                                                      | Description                         |
+| ------------------------------------------------------------ | ----------------------------------- |
+| [`@zpress/core`](https://www.npmjs.com/package/@zpress/core) | Config loading, sync engine, assets |
+| [`@zpress/cli`](https://www.npmjs.com/package/@zpress/cli)   | CLI commands and file watcher       |
+| [`@zpress/ui`](https://www.npmjs.com/package/@zpress/ui)     | Rspress plugin, theme, and styles   |
+
+## Why `@zpress/kit`?
+
+> [!NOTE]
+> Published as `@zpress/kit` because npm's overly aggressive moniker rules block the `zpress` name.
+
+## License
+
+[MIT](https://github.com/joggrdocs/zpress/blob/main/LICENSE) - Joggr, Inc.

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { }

package/dist/config.d.ts

@@ -0,0 +1,32 @@
+import { CardConfig } from '@zpress/core';
+import { defineConfig } from '@zpress/core';
+import { Entry } from '@zpress/core';
+import { Feature } from '@zpress/core';
+import { Frontmatter } from '@zpress/core';
+import { NavItem } from '@zpress/core';
+import { OpenAPIConfig } from '@zpress/core';
+import { WorkspaceGroup } from '@zpress/core';
+import { WorkspaceItem } from '@zpress/core';
+import { ZpressConfig } from '@zpress/core';
+
+export { CardConfig }
+
+export { defineConfig }
+
+export { Entry }
+
+export { Feature }
+
+export { Frontmatter }
+
+export { NavItem }
+
+export { OpenAPIConfig }
+
+export { WorkspaceGroup }
+
+export { WorkspaceItem }
+
+export { ZpressConfig }
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import { CardConfig } from '@zpress/core';
+import { createPaths } from '@zpress/core';
+import { createRspressConfig } from '@zpress/ui';
+import { defineConfig } from '@zpress/core';
+import { Entry } from '@zpress/core';
+import { Feature } from '@zpress/core';
+import { Frontmatter } from '@zpress/core';
+import { hasGlobChars } from '@zpress/core';
+import { loadConfig } from '@zpress/core';
+import { loadManifest } from '@zpress/core';
+import { Manifest } from '@zpress/core';
+import { ManifestEntry } from '@zpress/core';
+import { NavItem } from '@zpress/core';
+import { OpenAPIConfig } from '@zpress/core';
+import { PageData } from '@zpress/core';
+import { Paths } from '@zpress/core';
+import { ResolvedEntry } from '@zpress/core';
+import { ResolvedPage } from '@zpress/core';
+import { ResolvedSection } from '@zpress/core';
+import { resolveEntries } from '@zpress/core';
+import { Result } from '@zpress/core';
+import { SidebarItem } from '@zpress/core';
+import { sync } from '@zpress/core';
+import { SyncContext } from '@zpress/core';
+import { SyncOptions } from '@zpress/core';
+import { SyncResult } from '@zpress/core';
+import { WorkspaceGroup } from '@zpress/core';
+import { WorkspaceItem } from '@zpress/core';
+import { ZpressConfig } from '@zpress/core';
+import { zpressPlugin } from '@zpress/ui';
+
+export { CardConfig }
+
+export { createPaths }
+
+export { createRspressConfig }
+
+export { defineConfig }
+
+export { Entry }
+
+export { Feature }
+
+export { Frontmatter }
+
+export { hasGlobChars }
+
+export { loadConfig }
+
+export { loadManifest }
+
+export { Manifest }
+
+export { ManifestEntry }
+
+export { NavItem }
+
+export { OpenAPIConfig }
+
+export { PageData }
+
+export { Paths }
+
+export { ResolvedEntry }
+
+export { ResolvedPage }
+
+export { ResolvedSection }
+
+export { resolveEntries }
+
+export { Result }
+
+export { SidebarItem }
+
+export { sync }
+
+export { SyncContext }
+
+export { SyncOptions }
+
+export { SyncResult }
+
+export { WorkspaceGroup }
+
+export { WorkspaceItem }
+
+export { ZpressConfig }
+
+export { zpressPlugin }
+
+export { }

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@zpress/kit",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Documentation framework powered by Rspress with a config-driven information architecture",
+  "keywords": [
+    "docs",
+    "documentation",
+    "rspress",
+    "zpress"
+  ],
+  "homepage": "https://github.com/joggrdocs/zpress/tree/main/packages/zpress#readme",
+  "bugs": "https://github.com/joggrdocs/zpress/issues",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -17,26 +25,32 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs"
     },
     "./config": {
-      "types": "./src/config.ts",
+      "types": "./dist/config.d.ts",
       "import": "./dist/config.mjs"
     }
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
-    "@zpress/core": "0.2.0",
-    "@zpress/ui": "0.2.0",
-    "@zpress/cli": "0.1.1"
+    "@zpress/cli": "0.1.2",
+    "@zpress/core": "0.2.1",
+    "@zpress/ui": "0.2.1"
   },
   "devDependencies": {
     "@rslib/core": "^0.20.0",
     "typescript": "^5.9.3"
   },
+  "peerDependencies": {
+    "@rspress/core": "^2.0.5",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4"
+  },
   "engines": {
     "node": ">=24.0.0"
   },