为 MarkFlowy 做贡献

欢迎,并感谢你对 MarkFlowy 的关注与贡献!

如何贡献代码

前置条件

为下载必要工具、克隆仓库并通过 yarn 安装依赖,你需要可用的网络环境。

你需要准备以下工具:

目录

多语言翻译贡献步骤

对于不想跑完整开发环境、仅希望参与翻译的同学,可以参考以下步骤。

Fork

Fork MarkFlowy 并执行 git clone

翻译文件

新增一种语言

为方便大家参与,项目根目录的 locales 中存放了翻译文件。如果你想新增一种语言,可以直接参考 en.json 进行翻译。

修改现有语言

修改现有语言可能不太容易找到对应的键。如果在 locales 文件中找不到,你可以提 issue,我会帮助你找到相应的修改位置。

开发工作步骤

Fork

Fork MarkFlowy 并执行 git clone

安装依赖

执行以下命令安装相关依赖:

yarn install --immutable

cargo install --locked --path apps/desktop/src-tauri

启动 MarkFlowy

注意:首次启动前,需要执行 yarn build 来编译工作区里的包。

执行以下命令即可启动 MarkFlowy:

yarn dev:desktop

如何提交主题到主题商店

MarkFlowy 内置了主题商店功能,用户可以浏览、下载和安装社区创建的主题。如果你想将自己的主题提交到主题商店供其他用户使用,请参考 自定义主题文档 中的"分享你的主题"部分,该文档详细介绍了主题创建的完整流程和提交到主题商店的具体步骤。

致谢

无论大小,你对开源项目的贡献都会让它变得更好。感谢你抽出时间为 MarkFlowy 做出贡献!