una-editor 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Charles Tang
+
+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 THE WARRANTIES OF MERCHANTABILITY,
+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.en.md

@@ -0,0 +1,105 @@
+# Una Editor
+
+[English](./README.en.md) | [简体中文](./README.md)
+
+[![npm version](https://img.shields.io/npm/v/una-editor.svg?color=blue)](https://www.npmjs.com/package/una-editor)
+[![license](https://img.shields.io/github/license/charlestang/UnaEditor)](https://github.com/charlestang/UnaEditor/blob/main/LICENSE)
+[![Vue](https://img.shields.io/badge/Vue.js-35495E?logo=vue.js&logoColor=4FC08D)](https://vuejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vitejs.dev/)
+[![CodeMirror](https://img.shields.io/badge/CodeMirror-C53929?logo=codemirror&logoColor=white)](https://codemirror.net/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/charlestang/UnaEditor/pulls)
+
+A lightweight, high-performance Vue 3 editor component library based on CodeMirror 6.
+
+[**Live Demo 🚀**](https://charlestang.github.io/UnaEditor/)
+
+## ✨ Features
+
+- 🚀 **Powered by CodeMirror 6**: Provides robust foundational editing capabilities and excellent performance.
+- 🎨 **Vue 3 Friendly**: Built entirely with the Composition API, perfectly fitting the Vue ecosystem.
+- 💪 **Type Safe**: 100% written in TypeScript with complete type inference.
+- ⚡️ **Vite Driven**: Lightning-fast local development and build experience.
+- 📝 **Hybrid Markdown Rendering**: Optional hybrid rendering mode offering instant preview of headings, emphasis, code blocks, etc., within the editor.
+- ⌨️ **Vim Mode Support**: Built-in classic Vim modal editing and keybindings.
+- 📦 **Dual Output Formats**: Supports both ESM and CommonJS.
+
+## 📦 Installation
+
+Using pnpm (recommended):
+
+```bash
+pnpm add una-editor
+```
+
+Or using npm / yarn:
+
+```bash
+npm install una-editor
+# or
+yarn add una-editor
+```
+
+## 🚀 Quick Start
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { UnaEditor } from 'una-editor';
+
+const content = ref('# Hello Una Editor!');
+</script>
+
+<template>
+  <UnaEditor v-model="content" :hybrid-markdown="true" :vim-mode="false" />
+</template>
+```
+
+## 📖 API Documentation
+
+For detailed information on component properties (Props), events (Events), exposed methods (Methods), etc., please refer to our **[API Reference](./docs/api.en.md)**.
+
+## 🛠️ Local Development
+
+After cloning the project, you can start the local development environment and Playground using the following commands:
+
+```bash
+# Install dependencies
+pnpm install
+
+# Start local development and Playground
+pnpm dev
+```
+
+Visit `http://localhost:5173` to see the local debugging effect.
+
+### Other Useful Commands
+
+- `pnpm build`: Build production bundles (dist)
+- `pnpm test`: Run Vitest unit tests
+- `pnpm lint`: Run ESLint code checks
+- `pnpm format`: Run Prettier code formatting
+
+## 📁 Project Structure
+
+```text
+una-editor/
+├── src/                    # Core component source code
+├── playground/             # Local debugging environment (Vite App)
+├── docs/                   # Project documentation
+├── test/                   # Test files
+├── dist/                   # Build output directory
+└── openspec/               # OpenSpec change and specification management
+```
+
+## 🤝 Contributing
+
+Pull Requests and Issues discussing new features or bugs are highly welcome. Before submitting code, please ensure:
+
+1. All checks pass by running `pnpm lint` and `pnpm test`.
+2. Follow existing code formatting and [Conventional Commits](https://www.conventionalcommits.org/) message formats.
+3. For major feature changes, please refer to the design specification process in the `openspec/` directory first.
+
+## 📄 License
+
+This project is open-sourced under the [MIT License](./LICENSE).

package/README.md

@@ -0,0 +1,105 @@
+# Una Editor
+
+[English](./README.en.md) | [简体中文](./README.md)
+
+[![npm version](https://img.shields.io/npm/v/una-editor.svg?color=blue)](https://www.npmjs.com/package/una-editor)
+[![license](https://img.shields.io/github/license/charlestang/UnaEditor)](https://github.com/charlestang/UnaEditor/blob/main/LICENSE)
+[![Vue](https://img.shields.io/badge/Vue.js-35495E?logo=vue.js&logoColor=4FC08D)](https://vuejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vitejs.dev/)
+[![CodeMirror](https://img.shields.io/badge/CodeMirror-C53929?logo=codemirror&logoColor=white)](https://codemirror.net/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/charlestang/UnaEditor/pulls)
+
+基于 CodeMirror 6 构建的轻量级、高性能 Vue 3 编辑器组件库。
+
+[**在线演示 (Live Demo) 🚀**](https://charlestang.github.io/UnaEditor/)
+
+## ✨ 特性
+
+- 🚀 **基于 CodeMirror 6**：提供强大的底层编辑能力与优异的性能。
+- 🎨 **Vue 3 友好**：完全基于 Composition API 构建，完美契合 Vue 生态。
+- 💪 **类型安全**：100% TypeScript 编写，提供完整的类型推导。
+- ⚡️ **Vite 驱动**：极速的本地开发与构建体验。
+- 📝 **Hybrid Markdown 渲染**：可选的混合渲染模式，在编辑态即可获得标题、强调、代码块等元素的即时预览。
+- ⌨️ **Vim 模式支持**：内置经典的 Vim 模态编辑与键位绑定。
+- 📦 **双格式输出**：同时支持 ESM 和 CommonJS。
+
+## 📦 安装
+
+使用 pnpm (推荐):
+
+```bash
+pnpm add una-editor
+```
+
+或使用 npm / yarn:
+
+```bash
+npm install una-editor
+# 或
+yarn add una-editor
+```
+
+## 🚀 快速开始
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { UnaEditor } from 'una-editor';
+
+const content = ref('# Hello Una Editor!');
+</script>
+
+<template>
+  <UnaEditor v-model="content" :hybrid-markdown="true" :vim-mode="false" />
+</template>
+```
+
+## 📖 API 文档
+
+关于详细的组件属性 (Props)、事件 (Events)、对外暴露的方法 (Methods) 等内容，请查阅我们的 **[API 手册](./docs/api.md)**。
+
+## 🛠️ 本地开发
+
+克隆项目后，你可以通过以下命令在本地启动开发环境和 Playground：
+
+```bash
+# 安装依赖
+pnpm install
+
+# 启动本地开发与 Playground
+pnpm dev
+```
+
+访问 `http://localhost:5173` 即可查看本地调试效果。
+
+### 其他常用命令
+
+- `pnpm build`: 构建生产包 (dist)
+- `pnpm test`: 运行 Vitest 单元测试
+- `pnpm lint`: 运行 ESLint 代码检查
+- `pnpm format`: 运行 Prettier 格式化代码
+
+## 📁 项目结构
+
+```text
+una-editor/
+├── src/                    # 组件核心源码
+├── playground/             # 本地调试演示环境 (Vite App)
+├── docs/                   # 项目文档
+├── test/                   # 测试文件
+├── dist/                   # 构建输出目录
+└── openspec/               # OpenSpec 变更与规范管理
+```
+
+## 🤝 参与贡献
+
+欢迎提交 Pull Request 或开设 Issue 讨论新特性与 Bug。在提交代码前，请确保：
+
+1. 运行 `pnpm lint` 和 `pnpm test` 通过所有检查。
+2. 遵循现有的代码规范与 [Conventional Commits](https://www.conventionalcommits.org/) 提交信息格式。
+3. 较大的功能变更，请先查阅 `openspec/` 目录下的设计规范流程。
+
+## 📄 开源协议
+
+本项目基于 [MIT License](./LICENSE) 开源。