# lume

**Repository Path**: BlankNissan/lume

## Basic Information

- **Project Name**: lume
- **Description**: 一款基础的markdown编译器/阅读器
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-28
- **Last Updated**: 2026-03-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lume Note 📝

![Vue](https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge\&logo=vue.js\&logoColor=4FC08D)
![Electron](https://img.shields.io/badge/Electron-191970?style=for-the-badge\&logo=Electron\&logoColor=white)
![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge\&logo=vite\&logoColor=FFD62E)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\&logo=typescript\&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge\&logo=tailwind-css\&logoColor=white)

Lume 是一款基于 **Vue 3** + **Electron** + **Vite** 构建的现代化桌面端 Markdown 笔记应用。
借助 [Milkdown](https://milkdown.dev/) 编辑器内核，为你提供流畅的所见即所得 (WYSIWYG) 的 Markdown 写作体验。

## ✨ 特性

* ✍️ **现代化编辑器**: 基于 Milkdown，提供极佳的所见即所得 Markdown 编写体验。

* 📐 **图表与数学公式**: 内置 Mermaid 图表支持和 KaTeX 数学公式渲染。

* 💻 **代码高亮**: 集成 PrismJS 提供准确的代码语法高亮。

* 🛠️ **丰富的交互体验**: 支持 Slash 命令 (`/`) 唤出菜单、悬浮工具栏 (Tooltip)、块级编辑 (Block) 等高级特性。

* 🎨 **美观的 UI**: 采用 Tailwind CSS 和 Lucide Icons 构建现代且简洁的用户界面，搭配 Nord 代码主题。

* 🚀 **高性能**: 基于 Vite 驱动的极速启动与热更新体验。

* 🖥️ **跨平台桌面应用**: 依托于 Electron，支持打包为主流操作系统的本地应用。

## 📦 核心技术栈

* **前端框架**: [Vue 3](https://v3.vuejs.org/) `<script setup>`

* **构建工具**: [Vite](https://vitejs.dev/)

* **桌面容器**: [Electron](https://www.electronjs.org/) / `vite-plugin-electron`

* **开发语言**: [TypeScript](https://www.typescriptlang.org/)

* **UI 样式**: [Tailwind CSS](https://tailwindcss.com/)

* **富文本内核**: [Milkdown](https://milkdown.dev/) + [ProseMirror](https://prosemirror.net/)

## 🚀 快速开始

### 依赖环境

* Node.js 18+ 或更高版本

* npm / pnpm / yarn

### 安装

克隆项目并安装依赖：

```bash
# 使用 npm 安装项目依赖
npm install
```

### 开发环境调试

启动带有前端热重载自动刷新的本地开发环境：

```bash
# 启动 Vite 开发服务器并开启 Electron 窗口
npm run dev
```

### 构建与打包应用

构建生产级别的产物并打包为系统可执行文件：

```bash
# 完整构建并使用 electron-builder 打包应用
npm run build

# 仅指定打包为 Windows 端 (x64) 安装包
npm run builds
```

*打包完成后的可执行文件会在项目生成的特定分发目录下即可找到（如* *`dist`* *或相关构建输出目录）。*

## 目录结构预览

```text
note-app/
├── electron/           # Electron 主进程代码
├── src/                # Vue 3 前端渲染代码
│   ├── components/     # 公共组件 (如 Sidebar 等)
│   ├── App.vue         # 根组件
│   └── main.ts         # 前端 Vue 入口
├── index.html          # 前端 HTML 模板
├── package.json        # 项目依赖与指令说明
├── tailwind.config.js  # Tailwind CSS 配置文件
└── vite.config.ts      # Vite 与 Electron 插件配置
```

## 📄 许可证

项目目前为正在开发中的版本。

***

*Enjoy writing with Lume!* 🖋️