https://github.com/dj8yfo/meudeus

A skim-based `*.md` explore and surf tool
https://github.com/dj8yfo/meudeus

note-taking pkm

Last synced: 2 months ago
JSON representation

A skim-based `*.md` explore and surf tool

• Host: GitHub
• URL: https://github.com/dj8yfo/meudeus
• Owner: dj8yfo
• License: mit
• Created: 2023-01-22T09:51:00.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-09T16:14:33.000Z (4 months ago)
• Last Synced: 2024-04-10T18:49:29.870Z (2 months ago)
• Topics: note-taking, pkm
• Language: Rust
• Homepage:
• Size: 141 MB
• Stars: 39
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING
  • License: LICENSE

Lists

• cli-apps - meudeus - A skim-based `*.md` explore and surf tool. (<a name="note-taking"></a>Note taking)
• awesome-cli-apps - meudeus - A skim-based `*.md` explore and surf tool. (<a name="note-taking"></a>Note taking)

README

        


  

    

  

  

    

  



# Sample screencast

[![asciicast](https://asciinema.org/a/QtWI1lMVbQ52LMP7Yf6u7QvAA.svg)](https://asciinema.org/a/QtWI1lMVbQ52LMP7Yf6u7QvAA)

# [Installation](./INSTALLATION.md)

# 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](./config.kdl). 

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

# [Usage](./USAGE.md)

# [Keybindings](./KEYBINDINGS.md)

# Colors 

- Some color themes for markdown elements in `world.color.theme` field of [config](./config.kdl) can be found at [rainglow/sublime](https://github.com/rainglow/sublime)

and previewed at this awesome website [rainglow.io](https://rainglow.io/preview/).

- if the patchwork in markdown irritates you, please remember, that `settings.background` value in a theme 

is editable

- `world.color.elements` field of [config](./config.kdl) specifies colors of most of other displayed objects.

# [Changelog](./CHANGELOG.md)