conneroisu / sugar-rush

Obsidian Plugin for Oil/Vinegar Like Navigation within a Vault.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sugar Rush

contributorsforksstargazerslicenseissues

Obsidian Downloads Tests CodeQL CodeFactor

Logo

Sugar-Rush

A vim-vinegar or oil like file explorer that lets you edit your filesystem like a normal note/buffer in Obsidian.

Table of Contents
  1. Introduction
  2. Warning-Of-Use
  3. Use Cases
  4. Commands
  5. Contribution
  6. Acknowledgments

Visual Introduction

TODO: Put gif/video here.

TODO: add a See more examples link

Introduction

The goals of this plugin are to provide full control over the file system within your vault using a note as an interaction surface. Notes created with this plugin are hidden from searches within your vault to allow for a faultless adoption.

One can read more by going to the wiki

Details

Leader Commands?

Wanting to use a leader key to trigger commands for the plugin? I recommend tgrosinger's leader-hotkeys-obsidian. One can check out the guide to do this in terms of this repository here

Increment Map

Wanting to use g<C-a>? I would recommend using an specific increment map within your .obsidian.vimrc

Features

  • Edit your filesystem like a buffer (allows for creating, renaming, deleting, and moving)
  • Renaming of files hooks into actions inside of Obsidian so that plugins can readjust the links to and from a file.
  • Cross-Directory Actions

Developing

How the Plugin Works

Currently, the plugin keeps track of files and displays editable buffers of text that can allow the user to modify their file system.

Core Plugin Development

Looking to develop sugar-rush further? Checkout Developing

Expansive Plugin Development

Looking to develop sugar-rush to do something out of the project's scope of interacting with just the file system? Check out how you can expand this plugin with your own plugins here.

Contributors

Find contributors and thier information here at the wiki documentation.

About

Obsidian Plugin for Oil/Vinegar Like Navigation within a Vault.

License:MIT License


Languages

Language:TypeScript 95.5%Language:JavaScript 4.5%