@nikala-ui/docs 0.12.0 → 0.12.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Giorgi Magradze
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO QUALITY AND FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,22 +1,183 @@
 # @nikala-ui/docs
 
-Zero-config documentation engine for SolidJS, built on Nikala UI and Tailwind CSS v4.
+`@nikala-ui/docs` is a file-based documentation engine for SolidJS projects. It uses MDX, Vite, and Tailwind CSS v4 to build customizable documentation sites with local, copy-paste-owned components and hooks.
 
-## Features
+## What it provides
 
-- Vite-powered dev server and static build engine.
-- Nested file-based routing generated from `content/**/*.mdx`.
-- Pre-built Nikala UI theme with dark/light mode and Tailwind CSS v4 tokens.
-- Automatic Table of Contents and breadcrumbs extracted from headings and folder structure.
-- Shiki code syntax highlighting with language tabs and clipboard copy actions.
-- Integrated documentation components: Callout, Tabs, Steps, CodeGroup, FileTree, ApiTable.
+- MDX documentation with file-based routes.
+- Automatic sidebar categories from directories inside `docs/`.
+- Static production builds with server-rendered page content.
+- Development server with configuration and content hot reload.
+- Customizable SolidJS themes and layouts.
+- Syntax highlighting, table of contents, breadcrumbs, pagination, search, and dark mode.
+- Local Nikala UI component and reactive hook sources generated inside the consuming project.
+- Tailwind CSS v4 theme tokens generated as part of the project setup.
 
-## Usage
+The generated project does not import `@nikala-ui/core` or `@nikala-ui/hooks` at runtime. Components are copied into `src/components/ui`, and hooks are copied into `src/hooks`, so the consuming project owns and can modify the source code.
+
+## Create a documentation project
+
+Install the package in an existing SolidJS project or use the initializer to create the documentation structure:
+
+```bash
+bun add @nikala-ui/docs
+bunx @nikala-ui/docs init .
+```
+
+The initializer creates the following project files and directories:
+
+```text
+.
+├── docs/
+│   └── index.mdx
+├── docs.config.ts
+├── nikala.config.json
+└── src/
+    ├── components/ui/
+    ├── hooks/
+    ├── index.css
+    ├── lib/
+    ├── providers/
+    └── themes/custom/
+```
+
+The initializer also runs the Nikala UI project setup and installs the dependencies required by the generated local sources.
+
+## Development and production commands
+
+From the documentation project root:
 
 ```bash
-# Start local docs dev server
+# Start the development server
 bunx @nikala-ui/docs dev
 
-# Build production static output
+# Build the production site into dist/
 bunx @nikala-ui/docs build
+
+# Preview the production build
+bunx @nikala-ui/docs preview
+```
+
+Generated projects contain the same commands in `package.json`:
+
+```json
+{
+  "scripts": {
+    "dev": "bunx @nikala-ui/docs dev",
+    "build": "bunx @nikala-ui/docs build",
+    "preview": "bunx @nikala-ui/docs preview"
+  }
+}
+```
+
+## Content structure
+
+The default content directory is `docs/`. Every MDX file becomes a route, and directories become automatic sidebar categories.
+
+```text
+docs/
+├── index.mdx
+├── getting-started.mdx
+├── components/
+│   ├── button.mdx
+│   └── dialog.mdx
+└── guides/
+    └── theming.mdx
+```
+
+This produces routes such as:
+
+```text
+/
+/getting-started
+/components/button
+/components/dialog
+/guides/theming
+```
+
+Page metadata can be defined with frontmatter:
+
+```mdx
+---
+title: Button
+description: A flexible action button for SolidJS applications.
+order: 1
+toc: true
+---
+
+# Button
+
+Button documentation goes here.
+```
+
+Supported metadata includes `title`, `description`, `order`, `categoryOrder`, `icon`, `badge`, `addedAt`, `prev`, `next`, and `toc`.
+
+## Configuration
+
+Create or edit `docs.config.ts` in the project root:
+
+```ts
+export default {
+  title: "Project Documentation",
+  description: "Documentation for my SolidJS project",
+  siteUrl: "https://example.com",
+  contentDir: "docs",
+  navigation: {
+    layout: "sidebar",
+    sidebar: {
+      header: true,
+      footer: false,
+      headerSubtitle: "Developer Documentation",
+      footerText: "Documentation",
+    },
+  },
+  search: {
+    enabled: true,
+    provider: "local",
+  },
+  theme: {
+    path: "./src/themes/custom",
+    defaultMode: "system",
+  },
+};
+```
+
+Available configuration areas include:
+
+- `title`, `description`, and `siteUrl` for document metadata.
+- `contentDir` for the MDX content root.
+- `logo` for text, image, and logo link configuration.
+- `repository` for source repository links.
+- `nav` for top-level navigation items.
+- `sidebar` for explicit sidebar entries or automatic directory discovery.
+- `navigation` for sidebar or top navigation layout settings.
+- `theme` for the custom theme path and color mode.
+- `shiki` for code themes and supported languages.
+- `search` for search enablement and provider selection.
+
+## Custom themes
+
+The generated project includes a local theme under `src/themes/custom`. Modify its SolidJS components to customize the navbar, sidebar, content layout, navigation, overlays, and mobile table of contents.
+
+The generated `src/index.css` contains the Tailwind CSS v4 imports and semantic design tokens. Update those tokens to customize the light and dark color schemes without replacing the documentation engine.
+
+## Local components and hooks
+
+The initializer copies the component and hook sources needed by the generated documentation theme into the project:
+
+```ts
+import { Button } from "@/components/ui/button";
+import { createClipboard } from "@/hooks/create-clipboard";
+```
+
+The sources are ordinary project files. They can be inspected, customized, and extended without depending on a runtime UI registry package.
+
+## Package development
+
+Build this package from the Nikala UI monorepo with:
+
+```bash
+bun run build:docs
 ```
+
+The build bundles the documentation engine, registry manifests, and local source snapshots required by `@nikala-ui/docs init`.

package/dist/cli/commands/build.js

@@ -4,7 +4,7 @@ import { buildDocs } from "../../server/index.js";
 export async function runBuildCommand(dir, options = {}) {
     const outDir = options.outDir || "dist";
     console.log();
-    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.0"));
+    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.1"));
     console.log(pc.dim(`  Building documentation bundle from ${pc.bold(dir || "configured contentDir")} to ${pc.bold(outDir)}...`));
     console.log();
     const startTime = Date.now();

package/dist/cli/commands/dev.js

@@ -6,7 +6,7 @@ export async function runDevCommand(dir, options = {}) {
     const host = options.host || "localhost";
     const open = options.open ?? false;
     console.log();
-    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.0"));
+    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.1"));
     console.log(pc.dim("  Honoring Niko Pirosmani (Nikala) — Elegant docs for SolidJS"));
     console.log();
     try {

package/dist/cli/commands/init.js

@@ -272,7 +272,7 @@ async function writeProjectFiles(root, registryDependencies) {
 export async function runInitCommand(targetDir = ".") {
     const root = path.resolve(process.cwd(), targetDir);
     console.log();
-    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.0"));
+    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.1"));
     console.log(pc.dim(`  Initializing copy-paste documentation project in ${pc.bold(root)}...`));
     console.log();
     await fs.ensureDir(root);

package/dist/cli/commands/preview.js

@@ -6,7 +6,7 @@ export async function runPreviewCommand(dir = "docs", options = {}) {
     const host = options.host || "localhost";
     const outDir = options.outDir || "dist";
     console.log();
-    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.0"));
+    console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.1"));
     console.log(pc.dim(`  Previewing production build from ${pc.bold(outDir)}...`));
     console.log();
     try {

package/dist/cli/commands/serve.js

@@ -25,7 +25,7 @@ export async function runServeCommand(dir = ".", options = {}) {
     });
     server.listen(port, host, () => {
         console.log();
-        console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.0"));
+        console.log(pc.bold(pc.cyan("  Nikala Docs Engine ")) + pc.dim("v0.12.1"));
         console.log(pc.dim(`  SSR server: ${pc.bold(`http://${host}:${port}/`)}`));
         console.log();
     });

package/dist/cli/index.js

@@ -9,7 +9,7 @@ const program = new Command();
 program
     .name("@nikala-ui/docs")
     .description("Zero-config, fast, and elegant documentation engine for SolidJS")
-    .version("0.12.0");
+    .version("0.12.1");
 program
     .command("dev [dir]")
     .description("Start local development server with live MDX reload")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nikala-ui/docs",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "Zero-config, fast, and elegant documentation engine for SolidJS, built on Nikala UI and Tailwind CSS v4",
   "type": "module",
   "main": "./dist/index.js",
@@ -51,7 +51,7 @@
     "dev": "tsc -p tsconfig.build.json --watch"
   },
   "dependencies": {
-    "@nikala-ui/cli": "workspace:*",
+    "@nikala-ui/cli": "0.12.1",
     "@kobalte/core": "^0.13.12",
     "@mdx-js/mdx": "^3.1.0",
     "@mdx-js/rollup": "^3.1.0",