siyuan/.github/CONTRIBUTING.md

中文

Get the source code

• git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git For example saved in D:/siyuan/
• switch to dev branch

User Interface

Install pnpm: npm install -g pnpm

For China mainland

Set the Electron mirror environment variable and install Electron:

• macOS/Linux: ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/ pnpm install electron@25.0.1 -D
• Windows:
  • SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/
  • pnpm install electron@25.0.1 -D

NPM mirror:

• Use npmmirror China mirror repository pnpm --registry https://r.cnpmjs.org/ i
• Revert to using official repository pnpm --registry https://registry.npmjs.org i

On the desktop, go to the app folder to run:

• pnpm install electron@25.0.1 -D
• pnpm run dev
• pnpm run start

Note: In the development environment, the kernel process will not be automatically started, and you need to manually start the kernel process first.

Kernel

Desktop

• cd kernel
• go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"
• cd ../app/kernel
• ./SiYuan-Kernel.exe --wd=.. --mode=dev

iOS

• cd kernel
• gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./mobile/
• https://github.com/siyuan-note/siyuan-ios

Android

• cd kernel
• gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm64' ./mobile/
• https://github.com/siyuan-note/siyuan-android

For the mobile-end, please refer to the corresponding project repository.