Vita 🌱

Vita is a tool for digital gardening: creating, tending and publishing a collection of notes and ideas.

Vita takes a folder of plain text files and links them together to form a graph garden of knowledge. Vita takes influence from note-taking software like Obsidian and Roam Research.

An example note shown using Vita:

Vita requires Ruby 3.3.0.

To install:

$ gem install vita

In a folder containing text files, run vita to view your notes in a web browser:

$ vita
       _ _
__   _(_) |_ __ _
\ \ / / | __/ _` |
 \ V /| | || (_| |
  \_/ |_|\__\__,_|

Starting Vita at http://localhost:9000

Your web browser refreshes as you make changes to your files.

To publish:

$ vita publish

Vita creates a publish folder containing HTML files for publishing to a web server.

Vita looks for connections between notes. When a note's title (or a synonym) appears in the content of another note, Vita creates a link between the two.

When viewing a note, links in the note's content are hyperlinked:

A list of links from other notes to the current note follows the note's content:

Each link includes an excerpt from the other note. Clicking one of these links navigates to the other note.

Synonyms allow referring to notes using multiple names. Adding synonyms can be helpful when a note's title appears in other notes in different forms or tenses.

For example, notes may refer to a note titled "Cohesion" using terms like "cohesive", "coherent", or "coherence". Adding these words as synonyms to the "Cohesion" note allows Vita to connect the notes with links.

To specify a note's synonyms, add a Synonyms: line at the start of the file containing a comma-separated list of alternative names. For example, in a file called Cohesion.txt:

Synonyms: cohesive, coherent, coherence

A module is cohesive if the elements in the module are related and the module is coherent as a whole.

If a note titled Home exists, it is treated as a home page and shown when you open your notes. Other notes cannot link to the Home note.

Vita uses plain text files. You can create them using any text editor and save them with any file extension. You can optionally use Markdown or Org-mode syntax (.org files only) to add formatting to your notes.

You can customise Vita's appearance by creating a file named note.html.erb in your notes folder. This file overrides the default template. A good starting point is to copy the default template and make changes.

Vita is named for Vita Sackville-West, a twentieth-century author and garden designer and creator of Sissinghurst Castle Garden, a favourite place of mine.