#markdown #note-taking #skim #cli-tool #cli #pkm

app mds

A skim-based *.md explore and surf note-taking tool

6 releases (breaking)

0.19.0 Mar 9, 2024
0.18.6 Oct 5, 2023
0.18.5 Jun 17, 2023
0.11.4 Mar 28, 2023

#246 in Database interfaces

MIT and GPL-2.0 licenses

210KB
6K SLoC

Crates.io Build & Test

Sample screencast

asciicast

Installation

About

mds is a cli tool for

  1. navigating a collection of markdown notes
  2. creating new notes and linking them together. Notes' metadata and inter-note links are stored outside of them in .sqlite database.
  3. opening [description](links) found inside of markdown notes
  4. jumping to these [description](links)' location in markdown in editor (if one needs to change them)
  5. etc.

It links to external tools, such as bat via config.

mds works with any dumb editor. It doesn't require editor to have any kind of rich plugin system.

Usage

Keybindings

Colors

  • Some color themes for markdown elements in world.color.theme field of config can be found at rainglow/sublime and previewed at this awesome website rainglow.io.
  • if the patchwork in markdown irritates you, please remember, that settings.background value in a theme is editable
  • world.color.elements field of config specifies colors of most of other displayed objects.

Changelog

Dependencies

~76MB
~1.5M SLoC