Tencent / Tencent/cherry-markdown

[Client] V1 路线图 (Roadmap)

Open
#970 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

💻client 🚀enhancement
Dominant language
JavaScript
Stars
4.9k
Forks
572
Avg merge
17h 5m
Merged PRs (30d)
14

Description

目前将 client 从 electron 迁移到了 tauri2 进行实现, 见: https://github.com/Tencent/cherry-markdown/pull/969

当前功能主要需要实现有:

  • ci: 在每次pr之后能上传一个测试版 client 产物到 pr下,进行用户体验。
  • 优化save保存文件操作状态 — 当未修改或者已保存时进行​disabled,当文件被改变时进行重置到可操作状态。https://github.com/Tencent/cherry-markdown/pull/1584
  • 添加页脚 — 显示当前打开文件路径。
  • 添加title — 显示打开文件名。
  • link跳转 — 网页。
  • 图片展示 — 展示索引本地图片文件。
  • 增加导出长图、pdf 功能 https://github.com/Tencent/cherry-markdown/issues/1027
  • 保存文件状态提示 — 添加明显文件保存和为保存状态显示(具体实现方式待定)。
  • 新建文件
  • 打开新文件时 未保存文件保护 — 增加二次弹窗提示。 https://github.com/Tencent/cherry-markdown/pull/1584
  • Window menu — 添加 about=>添加客户端说明、商标、版本信息、repo 地址 和 更新日志等。
  • 调整窗口合适大小。
  • 屏蔽右键 tauri 客户端操作。https://github.com/Tencent/cherry-markdown/pull/1584
  • 增加部分快捷键用来处理文件 — 目前主要实现对于文件操作,如: 保存,另存为,新文件等。
  • 优化精简toolbar。
  • 版本自动更新。
  • 目前 window menu 和 system tary menu 的语言改变没有进行联动,使用 专门的本地缓存工具、或者小型本地数据库依赖,进行储存和控制全局配置(见: https://github.com/Tencent/cherry-markdown/pull/1031 )。
  • 使用纯预览的图标希望能使用 book 等图标(展示要进入预览模式)
  • 目前导出使用的是浏览器自带的功能,导出 图片、html 的时候不能选择导出的文件夹。

未来预期要实现功能(待定,目前不进行优先实现)。

  • 开屏 loading。
  • 增加面板展示文件目录 — (参考 可参考 vscode 客户端 和 https://github.com/lgou2w/HoYo.Gacha) 这里目前是对于已打开文件路径记录,(如果不存在文件移除并添加提示)。
  • Window下右键/默认使用客户端打开md文件以及 *.md 文件图标 logo 注册表注册。
  • 对于文件面板文件进行 标记tag分类 filter 展示。(创建tag,标记tag,未分类)。
  • 改变客户端主题和cherry-markdown一致 — 且在客户端menu实现同时切换两者的主题实现。
  • 图片点击放大预览。
  • 全屏模式切换 —— 目前 cherry-markdown 只有网页内全屏不能支持此功能,需自行扩展客户端内全屏的打开和关闭,另实现客户端全屏功能。
  • 插件化自定义主题。
  • 自定义nsis安装页面。
  • 自定义安装页面。
  • mac认证(待定)。
  • client内置picgo
  • 纯预览支持SSR

如有其他功能欢迎添加和讨论。

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

This is a broad roadmap rather than a single task. Start by choosing one unchecked client item and read the migration context in PR 969, plus the linked issue or pull request where relevant, such as issue 1027 or PRs 1584 and 1031. Define completion criteria for that item before making changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, tauri
Domain
desktop
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.