Contributing to Blank
Thanks for helping! Bug reports and ideas are best started as an issue. For code, fork the repository, create a branch and open a pull request against main. Commit messages are a single line of the form <type>: <summary>, e.g. fix: …, feat: … or docs: ….
Setup
Blank is a Tauri 2 app with a TypeScript + ProseMirror frontend in src/. You need bun, Rust and the Tauri prerequisites of your system.
The PDF helper, which draws the pages of PDF tabs, is built from MuPDF, a git submodule, so clone with git clone --recurse-submodules, or run git submodule update --init --recursive in a clone you already have. Building it also needs libclang: on Debian and Ubuntu sudo apt install libclang-dev, on macOS the Xcode command line tools, on Windows LLVM (winget install LLVM.LLVM) and MSBuild, which comes with the Visual Studio Build Tools of the Tauri prerequisites. MuPDF brings its own libraries, so nothing else. The first build compiles MuPDF, which takes a few minutes.
bun install
make dev # run the app with hot reload
make check # lint, format check and unit tests, same as the pre-commit hookRun make to list all tasks. They wrap the scripts in package.json, so bun run <script> works just as well, e.g. on Windows without make.
End-to-end tests
The tests in e2e/ drive the real app using tauri-driver and WebdriverIO. They run on Linux only.
- Install the prerequisites:
sudo apt install webkitgtk-webdriver xvfb(webkit2gtk-driverinstead ofwebkitgtk-webdriverbefore Ubuntu 26.04) andcargo install tauri-driver --locked - Build the app and run the tests:
make test-e2e, ormake test-e2e-headlesswithout a display
Set E2E_SKIP_BUILD=1 to reuse an existing debug build. Set E2E_PORT to run on another port than 4444, e.g. next to a second checkout. Each spec file runs the app with a fresh, temporary profile, so your own documents and settings are left untouched.
Documentation
The website at blank-writer.xyz lives in docs/ and is built with VitePress. Preview it with make docs-dev. If your change is visible to users, update the matching page in docs/guide/. The screenshots and GIFs come from the scripts in e2e/shots/: change those, not the images. CI captures them after the merge and proposes the changed ones in a pull request of their own. make docs-shot NAME="<title of the shot>" previews one locally (Linux, same prerequisites as the end-to-end tests).
Recommended IDE setup
VS Code with the Tauri and rust-analyzer extensions.