logo
0
0
WeChat Login
feat: 发布 simpleMarkdown v0.0.1

simpleMd

基于 Electron + React + Vite 的桌面端 Markdown 编辑器,界面简洁,支持源码与预览单列切换、多标签与本地文件读写。

功能概览

类别说明
编辑与预览同一主区域切换 源码 / 预览,非左右分栏
多文档侧栏「打开的文档」与顶部标签;无标题文档自动命名为「未命名 1、2…」,避免重名
未保存状态每个标签单独显示圆点;保存或另存为后清除
主题浅色 / 深色
导出MarkdownPDF(由当前渲染结果生成)
数学公式支持 $…$ / $$…$$,与预览共用 KaTeX
代码高亮基于 highlight.js
默认文档首次启动打开 Welcome.md(用法与语法简介),默认进入 预览

菜单:文件(新建、打开、保存、另存为、导出)、编辑视图帮助。快捷键与系统菜单一致(如 macOS 上 ⌘N / ⌘O / ⌘S 等)。

环境要求

  • Node.js 18+(建议 LTS)
  • npm 或兼容包管理器

安装依赖

npm install

开发

同时启动 Vite(localhost:5173)与 Electron 窗口:

npm run dev

仅在本机已有构建产物时调试 Electron(一般不用):

npm run build && npm run electron-dev

浏览器中预览静态构建(不含 Electron 能力):

npm run build && npm run preview

生产构建与打包

前端构建(TypeScript + Vite):

npm run build

生成应用图标(从 build/icon-source.svg 生成 build/icon.png 并同步 public/icon.svg):

npm run icon

打 macOS 安装包(zip,产物在 release/;会先执行 buildicon):

npm run electron-build

仅输出未封装目录便于本地试跑:

npm run electron:dir

若下载 Electron 二进制超时,项目已在 package.jsonbuild.electronDownload 中配置国内镜像;仍失败可检查网络或代理。打包产物以 当前系统 为准(如在 macOS 上得到 .app / .zip)。

项目结构(节选)

public/ main.cjs # Electron 主进程(窗口、菜单、IPC、PDF 导出等) preload.cjs # 预加载脚本 src/ App.tsx # 主界面与状态 components/ # Editor、Preview、TabBar、FileTree、WindowTitleBar 等 lib/ # Markdown 渲染等工具 build/ icon-source.svg # 应用图标源稿 scripts/ generate-icon.mjs # 生成 PNG 图标(sharp)

技术栈

  • React 18、TypeScript、Vite 5
  • Tailwind CSS、Marked、Highlight.js、KaTeX
  • Electron(桌面壳与系统菜单)

许可证

MIT License

欢迎 Issue 与 Pull Request。