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:
Table of Contents
Contribute multilingual translations steps
For some users who don't want to go through the complicated project startup steps and just want to participate in the translation work, you can check the following steps.
Fork
Fork MarkFlowy and git clone
Translation file
In order to facilitate everyone's participation, the translation file path is placed in locales in the project root directory. If you want to add a new language, you can directly refer to the en.json file for translation.
Development work steps
Fork
Fork MarkFlowy and git clone
Dependency installation
Execute the following command to install related dependencies.
yarn install
and
cargo install --locked --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.