Merge pull request #6 from BOSSincrypto/devin/1778410362-v1.1.1

feat: InkDown v1.1.1 — Menu Bar, pnpm Migration, macOS Fixes, SEO

Author: BOSSincrypto

.github/workflows/release.yml

@@ -13,13 +13,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: npx electron-builder --linux --x64 --publish never
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build
+      - run: pnpm exec electron-builder --linux --x64 --publish never
       - uses: actions/upload-artifact@v4
         with:
           name: linux-artifacts
@@ -31,13 +34,16 @@ jobs:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: npx electron-builder --win --x64 --publish never
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build
+      - run: pnpm exec electron-builder --win --x64 --publish never
       - uses: actions/upload-artifact@v4
         with:
           name: windows-artifacts
@@ -48,13 +54,16 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: npx electron-builder --mac --x64 --publish never
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run build
+      - run: pnpm exec electron-builder --mac --x64 --publish never
       - uses: actions/upload-artifact@v4
         with:
           name: mac-artifacts

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+package-lock.json
 dist/
 dist-electron/
 release/

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Thank you for your interest in contributing to InkDown! This guide will help you
 ### Prerequisites
 
 - [Node.js](https://nodejs.org/) >= 18.x
-- [npm](https://www.npmjs.com/) >= 9.x
+- [pnpm](https://pnpm.io/) >= 10.x
 - [Git](https://git-scm.com/)
 
 ### Getting Started
@@ -18,10 +18,10 @@ git clone https://github.com/BOSSincrypto/inkdown.git
 cd inkdown
 
 # Install dependencies
-npm install
+pnpm install
 
 # Start the development server
-npm run dev
+pnpm run dev
 ```
 
 ### Project Structure
@@ -39,6 +39,8 @@ inkdown/
 │   │   ├── Sidebar/    # File tree explorer
 │   │   ├── Toolbar/    # Formatting toolbar
 │   │   ├── TitleBar/   # Custom window title bar
+│   │   ├── MenuBar/   # In-app menu bar (File, Edit, etc.)
+│   │   ├── ContextMenu/ # Right-click context menu
 │   │   └── StatusBar/  # Bottom status bar
 │   ├── styles/         # Global CSS & themes
 │   └── types.d.ts      # TypeScript declarations
@@ -50,11 +52,11 @@ inkdown/
 
 ### Available Scripts
 
-- `npm run dev` — Start development server with hot reload
-- `npm run build` — Build the renderer
-- `npm run electron:build` — Build the full Electron app
-- `npm run lint` — Run ESLint
-- `npm run typecheck` — Run TypeScript type checking
+- `pnpm run dev` — Start development server with hot reload
+- `pnpm run build` — Build the renderer
+- `pnpm run electron:build` — Build the full Electron app
+- `pnpm run lint` — Run ESLint
+- `pnpm run typecheck` — Run TypeScript type checking
 
 ## Guidelines
 

README.md

@@ -2,23 +2,37 @@
 
 **The open-source WYSIWYG markdown editor you deserve.**
 
-InkDown is a beautiful, fast, and resource-efficient markdown editor — a free and open-source alternative to Typora. Write in markdown with a seamless live preview that renders your content as you type.
+InkDown is a beautiful, fast, and resource-efficient markdown editor — a free and open-source alternative to Typora. Write in markdown with a seamless live preview that renders your content as you type. Available for **Windows**, **macOS**, and **Linux**.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![GitHub release](https://img.shields.io/github/v/release/BOSSincrypto/inkdown)](https://github.com/BOSSincrypto/inkdown/releases)
+[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey)](https://github.com/BOSSincrypto/inkdown/releases)
 
 ---
 
+## Why InkDown?
+
+- **Free & Open Source** — No license fees, no subscriptions, no telemetry
+- **Typora-like Experience** — WYSIWYG markdown editing with real-time rendering
+- **Cross-Platform** — Native apps for Windows, macOS, and Linux
+- **Lightweight** — Optimized for minimal memory and CPU usage
+- **Privacy First** — Fully offline, no analytics, your data stays on your device
+
 ## Features
 
 - **WYSIWYG Markdown Editing** — Type markdown and see it rendered instantly. No split panes, no context switching.
+- **Menu Bar** — Full menu bar (File, Edit, Paragraph, Format, View, Help) with all editor actions and keyboard shortcuts, like Typora.
 - **Source Mode** — Toggle to raw markdown source view with a single shortcut (`Ctrl+/`).
 - **File Explorer** — Built-in sidebar with folder tree navigation for managing your markdown files.
 - **Dark & Light Themes** — Beautiful Catppuccin-inspired dark theme and a clean light theme.
 - **Focus Mode** — Distraction-free writing with `Ctrl+Shift+F`.
-- **Syntax Highlighting** — Code blocks with syntax highlighting for 30+ languages.
-- **Rich Formatting** — Headings, bold, italic, underline, strikethrough, highlight, blockquotes, lists, task lists, tables, images, links, horizontal rules, and more.
+- **Syntax Highlighting** — Code blocks with syntax highlighting for 30+ programming languages.
+- **Rich Formatting** — Headings (1–6), bold, italic, underline, strikethrough, highlight, blockquotes, ordered/unordered/task lists, tables, images, links, horizontal rules, and more.
 - **Export** — Export your documents to HTML or PDF.
 - **Keyboard Shortcuts** — Full set of keyboard shortcuts for power users.
-- **Cross-Platform** — Built with Electron for Windows (Linux and macOS coming soon).
-- **Resource Efficient** — Optimized for minimal memory and CPU usage.
+- **Context Menu** — Right-click context menu with quick formatting actions.
+- **File Association** — Double-click `.md` files to open them directly in InkDown.
+- **Resource Efficient** — Optimized startup time and minimal resource consumption.
 - **Privacy First** — No telemetry, no analytics, fully offline.
 
 ## Screenshots
@@ -29,7 +43,11 @@ InkDown is a beautiful, fast, and resource-efficient markdown editor — a free
 
 ### Download
 
-Download the latest release from the [Releases](https://github.com/BOSSincrypto/inkdown/releases) page.
+Download the latest release from the [Releases](https://github.com/BOSSincrypto/inkdown/releases) page:
+
+- **Windows**: `.exe` installer or portable version
+- **macOS**: `.dmg` disk image
+- **Linux**: `.AppImage` or `.deb` package
 
 ### Build from Source
 
@@ -38,14 +56,14 @@ Download the latest release from the [Releases](https://github.com/BOSSincrypto/
 git clone https://github.com/BOSSincrypto/inkdown.git
 cd inkdown
 
-# Install dependencies
-npm install
+# Install dependencies (requires pnpm)
+pnpm install
 
 # Run in development mode
-npm run dev
+pnpm run dev
 
 # Build for production
-npm run electron:build
+pnpm run electron:build
 ```
 
 ## Keyboard Shortcuts
@@ -61,34 +79,34 @@ npm run electron:build
 | Italic | `Ctrl+I` |
 | Underline | `Ctrl+U` |
 | Strikethrough | `Ctrl+Shift+X` |
-| Heading 1 | `Ctrl+1` |
-| Heading 2 | `Ctrl+2` |
-| Heading 3 | `Ctrl+3` |
+| Heading 1–6 | `Ctrl+1` to `Ctrl+6` |
 | Code | `Ctrl+E` |
 | Code Block | `Ctrl+Shift+K` |
 | Blockquote | `Ctrl+Shift+Q` |
+| Hyperlink | `Ctrl+K` |
 | Toggle Sidebar | `Ctrl+\` |
 | Toggle Source Mode | `Ctrl+/` |
 | Focus Mode | `Ctrl+Shift+F` |
 | Toggle Dark Mode | `Ctrl+Shift+D` |
 | Find | `Ctrl+F` |
-| Zoom In | `Ctrl++` |
-| Zoom Out | `Ctrl+-` |
-| Reset Zoom | `Ctrl+0` |
+| Zoom In | `Ctrl+Shift+=` |
+| Zoom Out | `Ctrl+Shift+-` |
+| Reset Zoom | `Ctrl+Shift+9` |
 | Fullscreen | `F11` |
 
+> On macOS, use `Cmd` instead of `Ctrl`.
+
 ## Tech Stack
 
 - **[Electron](https://www.electronjs.org/)** — Cross-platform desktop framework
 - **[React](https://react.dev/)** — UI library
 - **[Tiptap](https://tiptap.dev/)** — Headless WYSIWYG editor framework (ProseMirror-based)
 - **[TypeScript](https://www.typescriptlang.org/)** — Type-safe JavaScript
 - **[Vite](https://vitejs.dev/)** — Lightning-fast build tool
+- **[pnpm](https://pnpm.io/)** — Fast, disk-efficient package manager
 
 ## Roadmap
 
-- [ ] Linux support
-- [ ] macOS support
 - [ ] Android support (via React Native or similar)
 - [ ] Plugin/extension system
 - [ ] Custom themes
@@ -121,4 +139,4 @@ This project is licensed under the MIT License — see the [LICENSE](LICENSE) fi
 
 ---
 
-**InkDown** — Write beautifully. Open source.
+**InkDown** — Write beautifully. Open source. Free forever.