Skip to content

sevonj/scratchmark

Repository files navigation

CI Status Badge Translation Status Badge

**Scratchmark** is a pleasant Markdown editor for writing. It tries to give you everything you need and otherwise stay out of your way so you can just focus on the text. The app can be used for writing essays and making quick notes alike. Its file management is built around a folder structure that can handle large projects with lots of files. You can add any folder on your computer to the library, and move files around by dragging and dropping.

Scratchmark is intended to become a spiritual successor to ThiefMD.

screenshot

screenshot

screenshot

cat

Get Scratchmark

Linux

Get it on Flathub

Windows

(planned)

Contribute

I want you

🫵

to contribute

Enlist now!

➜ Translation
➜ Project Backlog
➜ Website Repository

If you find an issue that's important to you, give it a thumbs up.
You're also welcome to improve the website, which is currently rather barebones.

Developers

Scratchmark is written in Rust and uses GTK4 and Libadwaita for UI.

License

Scratchmark is licensed GPL-3.0-or-later. Some parts may additionally be available under other licenses, such as MIT.

Building

The project is transitioning to Meson build system, but it remains possible to build and run it with Cargo.

Cargo

When running from the repository, there's an additional step to the usual cargo run command. You need to set an env var to tell the app where to find it:

export GSETTINGS_SCHEMA_DIR=$PWD/data

The app needs its settings schema, and the lookup path seemingly can't be set in the code itself.

Continuous Integration

Pull requests are gatekept by this workflow. It will check if the code

  • builds (you don't say)
  • passes unit tests (run cargo test)
  • has linter warnings (run cargo clippy)
  • is formatted (run cargo fmt)

Dependencies

Ubuntu

libgtk-4-dev build-essential libglib2.0-dev libadwaita-1-dev libgtksourceview-5-dev

Flatpak

Generating a Flatpak

Dependencies

You need Flatpak w/ Flathub and the following packages:

org.gnome.Sdk//49

Building

Build & install:

cd build-aux
sh generate_flatpak.sh && flatpak install Scratchmark.flatpak --user -y

About

Organized markdown editor

Resources

License

Stars

Watchers

Forks

Packages

No packages published