⚠️ 注意：当前版本为预览版（Beta），可能存在不稳定因素。欢迎测试并反馈问题！
Quarkdown GUI 是一个为 Quarkdown 命令行工具打造的现代化图形用户界面，旨在为用户提供更友好的使用体验。通过直观的界面操作，用户可以轻松创建、编译和预览 Quarkdown 文档，而无需直接使用命令行。
- 现代化界面: 基于 Electron 和 Bootstrap 构建的美观、直观的用户界面
- 项目管理: 管理现有项目、记录最近打开的项目
- 编译功能: 轻松编译 Quarkdown 文档，支持多种输出格式
- 界面定制: 支持浅色/深色主题切换
- 跨平台支持: 兼容 Windows、macOS 和 Linux 平台
- Windows 10/11, macOS 10.14+, 或 Linux
- Quarkdown 命令行工具已安装并可访问
前往 Releases 页面，下载适用于您操作系统的安装包。
- 确保安装了 Node.js (建议 v16+) 和 npm
- 克隆仓库：
git clone https://github.com/qiokio/quarkdown-gui.git cd quarkdown-gui - 安装依赖：
npm install - 启动应用：
npm start - 构建应用：
# Windows npm run build:win # macOS npm run build:mac # Linux npm run build:linux
首次启动应用时，请前往「设置」页面配置 Quarkdown 命令行工具的路径。如果 Quarkdown 已添加到系统 PATH 中，则可以保留默认设置。
- 点击首页的「创建新项目」按钮或导航到「项目」页面
- 输入项目名称并选择保存位置
- 点击「创建项目」按钮
- 导航到「编译」页面
- 选择要编译的 Quarkdown 文件
- 选择所需的输出格式
- 点击「开始编译」
- 导航到「预览」页面
- 选择编译后生成的文件（HTML/PDF）
- 点击「加载预览」按钮
在「设置」页面，可以配置以下选项：
- Quarkdown 路径: 指定 Quarkdown 命令行工具的路径
- 默认项目目录: 设置默认的项目保存位置
- 界面主题: 选择浅色、深色或跟随系统设置
Quarkdown GUI 使用以下技术栈构建：
- Electron: 跨平台桌面应用框架
- HTML/CSS/JavaScript: 前端界面技术
- Bootstrap 5: UI 组件库
- Node.js: 后端运行环境
欢迎贡献代码、报告问题或提出改进建议！请遵循以下步骤：
- Fork 本仓库
- 创建您的特性分支 (
git checkout -b feature/amazing-feature) - 提交您的更改 (
git commit -m 'Add some amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 开启一个 Pull Request
本项目采用 MIT 许可协议 - 详情请查看 LICENSE 文件。
如有问题或建议，请通过 Issues 与我们联系。