https://github.com/conneroisu/sugar-rush

Obsidian Plugin for Oil/Vinegar Like Navigation within a Vault.
https://github.com/conneroisu/sugar-rush

Last synced: 5 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/conneroisu/sugar-rush
• Owner: conneroisu
• License: mit
• Created: 2023-11-06T00:55:58.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-27T20:03:26.000Z (5 months ago)
• Last Synced: 2025-01-27T21:22:36.054Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.09 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Sugar Rush



[![contributors](https://img.shields.io/github/contributors/conneroisu/sugar-rush.svg?style=for-the-badge)](https://github.com/conneroisu/sugar-rush/graphs/contributors)[![forks](https://img.shields.io/github/forks/conneroisu/sugar-rush.svg?style=for-the-badge)](https://github.com/conneroisu/sugar-rush/network/members)[![stargazers](https://img.shields.io/github/stars/conneroisu/sugar-rush.svg?style=for-the-badge)](https://github.com/conneroisu/sugar-rush/stargazers)[![license](https://img.shields.io/github/license/conneroisu/sugar-rush.svg?style=for-the-badge)](https://github.com/conneroisu/sugar-rush/blob/master/LICENSE)[![issues](https://img.shields.io/github/issues/conneroisu/sugar-rush.svg?style=for-the-badge)](https://github.com/conneroisu/sugar/issues)

![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22sugar-rush%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json)

[![Tests](https://github.com/conneroisu/sugar-rush/actions/workflows/test-push-brach.yml/badge.svg)](https://github.com/conneroisu/sugar-rush/actions/workflows/test-push-brach.yml)

[![CodeQL](https://github.com/conneroisu/sugar-rush/actions/workflows/codeql.yml/badge.svg)](https://github.com/conneroisu/sugar-rush/actions/workflows/codeql.yml)

[![CodeFactor](https://www.codefactor.io/repository/github/conneroisu/sugar-rush/badge)](https://www.codefactor.io/repository/github/conneroisu/sugar-rush)

  
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



    
Introduction

    
Warning-Of-Use

    


Use Cases 

    
Commands

    
Contribution

    
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](https://github.com/conneroisu/sugar-rush/wiki)

## Details

### Leader Commands?

Wanting to use a leader key to trigger commands for the plugin? I recommend [tgrosinger's leader-hotkeys-obsidian](https://github.com/tgrosinger/leader-hotkeys-obsidian).

One can check out the guide to do this in terms of this repository [here]()

### Increment Map

Wanting to use `g`? 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](https://github.com/conneroisu/sugar-rush/wiki/Development)

### 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](https://github/com/conneroisu/sugar-rush/wiki/Contributors) at the wiki documentation.