/flintstone

A small script to open .md files with Obsidian

Primary LanguageRust

🪨 flintstone

DeepSource

flintstone is a simple script I wrote to make setting Obsidian as the default Markdown editor easy. It can run on all operating systems* (but the only reason it's written in Rust is that bash can't parse json without external programs).

(* I have no idea where the obsidian.json file is on non-*nix OSes. Probably AppData or smth, but I didn't hard-code it without testing. You can provide its location with the -p/--path argument)

Installation

Clone this respository, then install it using cargo.

  $ git clone https://github.com/riceicetea/wwhatis && cd wwhatis
  $ cargo install --path .

or, on *Nix,

$ direnv allow
$ nix build

You can also install the flake as a system package.

Usage/Examples

USAGE:
    flintstone [OPTIONS] [FILES]...

ARGS:
    <FILES> List of files to open. The program will decide if it's inside an obsidian vault or not, then open accordingly

OPTIONS:
    -a, --about          Print the about page and info about used libraries
    -p, --path           a path to your obsidian.json file.

On GNOME, for example, open Files, right click a .md file, select Open With, then choose flintstone. The app doesn't have an icon yet, but that is a work in progress.

Acknowledgements

Check Cargo.toml or thirdparty/THIRDPARTY for the full list of packages.