https://github.com/JonasDoesThings/obsidian-hide-folders

Toggle the visibility of folders in the Obsidian.MD file navigator based on name-patterns
https://github.com/JonasDoesThings/obsidian-hide-folders

obsidian obsidian-md obsidian-plugin obsidian-vault obsidianmd

Last synced: 3 months ago
JSON representation

Toggle the visibility of folders in the Obsidian.MD file navigator based on name-patterns

• Host: GitHub
• URL: https://github.com/JonasDoesThings/obsidian-hide-folders
• Owner: JonasDoesThings
• License: mit
• Created: 2022-11-14T17:51:01.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-25T18:29:26.000Z (6 months ago)
• Last Synced: 2024-06-25T20:22:18.414Z (6 months ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, obsidian-vault, obsidianmd
• Language: TypeScript
• Homepage:
• Size: 276 KB
• Stars: 27
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# obsidian-hide-folders

A simple plugin for [obsidian.md](https://obsidian.md) that hides configured folders, with the ability to toggle their visibility.  

This can be used for hiding attachments folders when you don't need them.

  

## Installation

Search in the community plugins menu of Obsidian for "Hide Folders" look for the right plugin ("by JonasDoesThings"), there you can install the latest stable version.  

![Screenshot of the Plugin Installation Menu](./docs/assets/installation-screenshot.png)

## Configuration

Enter the list of folder names to hide in the settings menu, **one folder per line**.

You can match folders using three ways:

* Exact folder-names (for example `attachments`)

* All folders **starting with** a specific string (for example `startsWith::_` to filter out all folders whose name starting with a `_`)

* All folders **ending with** a specific string (for example `endsWith::_trash` to filter out all folders whose name is ending with `_trash`)

![Screenshot of the Plugin Settings Screen in Obsidian.md](./docs/assets/settings-screenshot.png)  

You can then also use a sidebar button to quickly toggle the visibility without having to enter the settings menu:  

![Screenshot of the Plugin's Sidebar Button in Obsidian.md](docs/assets/sidebar-screenshot.png)

Using the command palette is also supported:  

![Screenshot of the Plugin's Command Palette Action in Obsidian..md](docs/assets/command-palette-screenshot.png)

## Development

### Setup

- Clone this repo.

- `npm i` or `yarn` to install dependencies

- `npm run dev` to start compilation in watch mode.

### Building

- `npm run build` to do a one-off build of the project, which produces the files needed for manually installing the plugin.

### Manually installing the plugin

- Copy over the outputted `main.js`, `manifest.json` from the `dist/` folder to your vault `VaultFolder/.obsidian/plugins/obsidian-hide-folders/`.  

-> Watch Out! You cannot copy-over the raw *main.**ts***. You need to run a build first and then copy over the produced *main.**js***.

## Support my work

I am maintaining free open source tools like this in my free-time.  

If I helped you, and you want to give back, you can [buy me a coffee (green tea)](https://www.buymeacoffee.com/jonasdoesthings).

## License

MIT License, see [LICENSE.md](./LICENSE.md)