crates.io

Get focused

Alt

Flow

  1. Install the beast itself.

cargo install --locked mds

  1. Install external commands used in default config, besides firefox, which is the default browser for opening links, by running install_dependencies.sh wget -O - https://raw.githubusercontent.com/dj8yfo/mds/master/install_dependencies.sh | bash
  2. Create config at $HOME/.config/mds/config.kdl with content.
  3. Check your config got correctly fetched up. mds debug-cfg

  4. Initialize .sqlite database in your notes folder with mds init

  5. Enjoy (fast gif tutorial is here):

    Both explore and surf are equipped with <Ctrl-h> and <Ctrl-l> keybindings to follow backlinks and forward links respectively.

    mds -h

    ``` Usage: mds [OPTIONS]

    Commands: debug-cfg print Debug representtion of config init initialize .sqlite database in notes dir, specified by config n create a note t create a tag (note without file body) l link 2 notes A -> B, selected twice in skim interface o start an infinite skim selection loop to open notes/tags e explore notes by (backlinks) , (links forward) s surf (fuzzy find) through all [markdown reference](links) and code_block(s), found in all notes, reachable by forward links from note/tag S, selected interactively by skim unlink unlink 2 notes A -> B, selected twice in skim interface remove remove note R, selected in skim interface rename rename note R, selected in skim interface p print tree of nodes reachable by forward links from note P, selected either non-interactively or in skim interface select select note S, i.e. print its name to stdout help Print this message or the help of the given subcommand(s)

    Options: -c, --color whether color output should be forced -h, --help Print help -V, --version Print version ```