cadmus

Shell Scripts to Facilitate Effective Note Taking

Philosophy

• Be a Front end to tie together different scripts and tools
• Don't replicate work other people have done.
• Plain Text, Open Source.

Installation

To install, satisfy the dependencies and do something like this:

cd ~/DotFiles

if [[ -d ".git" ]]; then
    echo "Adding Submodule";
    git submodule add https://github.com/RyanGreenup/cadmus
else echo "Cloning Repository";
    git clone https://github.com/RyanGreenup/cadmus
fi

stow -t $HOME -S cadmus

Usage

It's all Menu driven so just follow the diagram to do what you need.

Assumptions

It is assumed that notes are:

1. Markdown files with a .md extension
2. Underneath ~/Notes
3. Recoll updates it's index on the fly
   • ~/Notes will need to be indexed by Recoll so the results will show up.

Dependencies

• R
• highlight
• node
• nvim
• fzf
• code
• sk
• rg
• perl
• stow
• python
• tmsu^AUR
• ranger
• mdcat^AUR
  • Kitty or iterm2
• xclip
• sd
• fd
• sed
• cut
• grep
• find
• GNU realpath
• Recoll
• MkDocs
  • MkDocs Material Theme
  • MkDocs Material Extensions
• VNote
• Pandoc

Related

• DNote
• TNote
• Notable