Skip to content

Tomanal/new-md

Repository files navigation

NewMD

智能看板笔记应用 —— 集 Markdown 笔记、可视化看板、RSS 资讯订阅于一体的桌面效率工具。

功能特性

Markdown 笔记

  • 基于 Milkdown 的所见即所得编辑器
  • 实时自动保存,防丢失
  • 独立编辑器窗口,支持多文件并行编辑
  • 文件重命名、删除、整理到文档库

可视化看板

  • 自由拖拽布局的组件化看板
  • 内置组件:待办事项、日历、天气、备忘录、快捷链接、RSS 资讯
  • 支持多看板、预设模板一键创建
  • 右键菜单管理组件

RSS 资讯订阅

  • 多源 RSS 聚合,定时自动刷新
  • 应用内文章预览与阅读
  • LLM 智能筛选 + 自动归档为 Markdown 文档
  • 网页内容抓取与图片本地化

文档库

  • 树状分类目录管理
  • LLM 辅助内容整理与归档
  • 支持按日期自动归类

其他

  • 系统托盘常驻,最小化到托盘
  • 窗口置顶 / 锁定大小
  • 本地 API 服务器(端口 17634)

技术栈

  • 框架: Electron 28 + React 18 + TypeScript
  • UI: TailwindCSS 3 + Lucide Icons
  • 编辑器: Milkdown (ProseMirror)
  • 看板: react-grid-layout
  • 状态管理: Zustand
  • 路由: React Router 7
  • 构建: Vite 5 + electron-builder

快速开始

安装依赖

npm install

开发模式

npm run dev

构建

npm run build

打包 Windows 安装程序

npm run dist:win

产物位于 release/ 目录:

  • NewMD Setup 0.1.0.exe — 安装版
  • NewMD 0.1.0.exe — 便携版

项目结构

src/
├── main/                  # Electron 主进程
│   ├── index.ts           # 应用入口
│   ├── window-manager.ts  # 窗口管理
│   ├── ipc/               # IPC 通信处理器
│   │   ├── handlers.ts
│   │   ├── note-handlers.ts
│   │   ├── board-handlers.ts
│   │   └── doc-handlers.ts
│   └── services/          # 后台服务
│       ├── note-service.ts
│       ├── board-service.ts
│       ├── doc-service.ts
│       ├── rss-agent.ts
│       ├── tray-service.ts
│       └── api-server.ts
├── preload/               # 预加载脚本(安全桥接)
│   ├── index.ts
│   └── types.d.ts
└── renderer/              # React 前端
    └── src/
        ├── components/    # 通用组件
        ├── pages/         # 页面
        ├── stores/        # Zustand 状态
        ├── hooks/         # 自定义 Hooks
        ├── types/         # 类型定义
        ├── utils/         # 工具函数
        └── styles/        # 样式文件

数据目录

应用运行时数据存储在项目根目录下:

目录 用途
markdown-files/ Markdown 笔记文件
boards/ 看板配置与数据
docs/ 文档库(归档、整理的文档)
resources/ 应用图标等资源

配置

LLM 配置(用于 RSS 智能筛选和文档整理)通过应用内设置界面配置,存储在 settings.json

支持 OpenAI 兼容的 API 接口。

许可证

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors