mind-hiro 0.2.0 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # Mind Hiro
 
-Generate a **self-contained, interactive mind-map website** from a folder of Markdown files — one HTML file, works offline, no server needed.
+Generate a **self-contained, interactive mind-map site** from a folder of Markdown files — single HTML file, works offline, no server needed.
 
 Powered by [markmap](https://markmap.js.org/) + [Vite](https://vitejs.dev/).
 
@@ -8,31 +8,38 @@ Powered by [markmap](https://markmap.js.org/) + [Vite](https://vitejs.dev/).
 
 ## Features
 
-- **Three-panel UI** — sidebar file list, Markdown editor, live mind-map renderer
+- **Three-panel UI** — file sidebar, Markdown editor, live mind-map renderer
+- **Command palette** — `⌘K` to search files and run actions (toggle theme, share, …)
 - **Live editing** — edit Markdown in the browser; mind map updates in real time
-- **Search** — filter files by filename or content
-- **Share links** — compress current Markdown into a URL hash and copy to clipboard
-- **Dark / light mode** — persisted to `localStorage`
-- **Local edits saved** — browser remembers your edits per file across sessions
+- **Full-text search** — filter files by filename or content
+- **Share links** — compress the current file into a URL hash and copy to clipboard
+- **Dark / light mode** — toggled via toolbar or command palette, persisted to `localStorage`
+- **Local edits saved** — browser remembers edits per file across sessions
 - **Fully self-contained** — all JS/CSS inlined; no CDN, works offline
 
 ---
 
-## CLI
+## Quick start
 
 ```bash
-npx mind-hiro generate <dir> [options]
+npx mind-hiro generate ./docs -o site.html
 ```
 
+Open `site.html` in any browser — no server needed.
+
+---
+
+## CLI
+
 ```
+mind-hiro generate <dir> [options]
+
 Options:
-  -o, --output <file>   Output HTML file (default: mind-hiro.html)
+  -o, --output <file>   Output HTML file  (default: mind-hiro.html)
   -r, --recursive       Scan subdirectories recursively
   -h, --help            Show help
 ```
 
-### Examples
-
 ```bash
 # Generate from a docs folder
 npx mind-hiro generate ./docs -o site.html
@@ -41,11 +48,7 @@ npx mind-hiro generate ./docs -o site.html
 npx mind-hiro generate ./notes -r -o notes.html
 ```
 
-Then open `site.html` in any browser — no server needed.
-
----
-
-## Install globally
+### Install globally
 
 ```bash
 npm install -g mind-hiro
@@ -58,26 +61,26 @@ mind-hiro generate ./docs -o site.html
 
 ```ts
 import { generate } from 'mind-hiro'
+import { writeFileSync } from 'fs'
 
 const html = generate([
   { name: 'Architecture', content: '# Architecture\n## Frontend\n## Backend' },
   { name: 'Roadmap',      content: '# Roadmap\n## Q1\n## Q2' },
 ])
 
-import { writeFileSync } from 'fs'
 writeFileSync('output.html', html)
 ```
 
 ### `generate(files): string`
 
-| Parameter | Type | Description |
-|---|---|---|
-| `files` | `MindMapFile[]` | Array of `{ name: string, content: string }` objects |
-| returns | `string` | Self-contained HTML string |
+| Parameter | Type            | Description                                    |
+|-----------|-----------------|------------------------------------------------|
+| `files`   | `MindMapFile[]` | Array of `{ name: string, content: string }` objects |
+| returns   | `string`        | Self-contained HTML string                     |
 
 ```ts
 interface MindMapFile {
-  name: string     // Shown in the sidebar (filename without extension)
+  name: string     // Shown in the sidebar
   content: string  // Raw Markdown content
 }
 ```
@@ -87,14 +90,27 @@ interface MindMapFile {
 ## Development
 
 ```bash
-git clone https://github.com/your-username/mind-hiro
+git clone https://github.com/minhonglolz/mind-hiro
 cd mind-hiro
 npm install
 
-npm run dev        # Start Vite dev server
-npm run build      # Build app + CLI
+npm run dev          # Vite dev server (hot reload)
+npm run build        # Build app template + CLI
+npm run type-check   # TypeScript check without emitting
 ```
 
+### Project structure
+
+```
+app/          Vite app — the embedded viewer UI (TS + Tailwind)
+src/          CLI + programmatic API (Node.js)
+shared/       Types shared between app and src
+index.html    Dev entry point
+```
+
+`npm run build:app` bundles `app/` into `template/index.html` (the inlined shell).
+`npm run build:lib` compiles `src/` into `dist-lib/` (the CLI + API).
+
 ---
 
 ## License

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "mind-hiro",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Generate a self-contained interactive mind-map website from Markdown files",
   "type": "module",
   "main": "./dist-lib/src/index.js",
   "bin": {
-    "mind-hiro": "./dist-lib/src/cli.js"
+    "mind-hiro": "dist-lib/src/cli.js"
   },
   "exports": {
     ".": {