Skip to content

Home

Jump to bottom
Linus Mußmächer edited this page Aug 19, 2024 · 5 revisions

Welcome to the rucola wiki!

Rucola is a terminal user interface designed to manage a folder of interconnected markdown notes, providing a common interface to access information about your notes as well as external editing and viewing programms.

Wiki Contents

Usage

Rucola can be run with the rucola command from your terminal. It will then start to index all markdown files in your vault directory, which is (highest to lowest priority) either

  • passed as a positional argument
  • specified in your config file
  • the current directory.

Warning

If you run rucola in your home directory without either the positional argument or the vault_path entry in the configuration file, rucola will index all markdown files in your entire home directory, which might take a very long time.

While indexing, rucola will ignore hidden files & folders and adhere to any .gitignore files along the way. It will then show a Select Screen with a list of all the found notes, along some statistics about each note and the whole set. This list can be filtered to find specific notes or to view statistics about subsets of your notes. You can then rename, move or delete them or view more specific information about each note in a Display Screen that lets your trace paths through your note graph and explore new connections. Additionally, rucola serves as a hub application to access an external editor or convert your notes to HTML on the fly and view the output in another programm.

Important

If you do not wish for rucola to continuously create HTML files of your notes, remember to disable this behavior in your config file.

Your can customize the look of rucola with a style file, either set in your config file or by passing the -s <style_file_name> argument.

Links

Rucola will find links in any of the following forms:

  • [[target-note]]
  • [[displayed-text|target-note]]
  • [displayed-text](target-note) (only if target-note contains not . or /, to differentiate from external links.

where target-note is the name, not path, of the note to link to. You may freely replace (space) with -(dash) in the name and/or ignore cases.

Clone this wiki locally