Contributing to MarkFlowy

Welcome, and thank you for your interest in contributing to MarkFlowy!

How to Contribute Code

Prerequisites

In order to download necessary tools, clone the repository, and install dependencies via yarn, you need network access.

You'll need the following tools:

• Git
• Node.JS >= 16.x
• yarn 3.6.1
• rust >= 1.72.0

Steps

Fork

Fork MarkFlowy and git clone

Dependency installation

Execute the following command to install related dependencies.

yarn install

and

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

Startup MarkFlowy

Execute the following command, you will start MarkFlowy.

yarn dev:desktop

Thank You!

Your contributions to open source, large or small, make the project better. Thank you for taking the time to contribute.