https://github.com/jamiefdhurst/obsidian-inbox-organiser
Obsidian plugin to capture any new notes into an inbox and periodically prompt to organise these into other folders within the vault.
https://github.com/jamiefdhurst/obsidian-inbox-organiser
notes obsidian pkm plugin typescript
Last synced: 6 months ago
JSON representation
Obsidian plugin to capture any new notes into an inbox and periodically prompt to organise these into other folders within the vault.
- Host: GitHub
- URL: https://github.com/jamiefdhurst/obsidian-inbox-organiser
- Owner: jamiefdhurst
- License: mit
- Created: 2024-11-12T15:42:12.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T10:39:24.000Z (8 months ago)
- Last Synced: 2025-03-30T01:30:40.116Z (6 months ago)
- Topics: notes, obsidian, pkm, plugin, typescript
- Language: TypeScript
- Size: 464 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Inbox Organiser for Obsidian
Capture any new notes into an inbox and periodically prompt to organise these into other folders within the vault.
Designed to work with [Obsidian](https://obsidian.md).
## Features
- Collects all new and unorganised notes saved into the root of your vault into an inbox folder
- Provides an interface to organise your inbox and move your unorganised files into other folders within your vault easily
- Periodically reminds you to clear your inbox
## Settings
You can configure whether to automatically move any newly created files in the root folder into the inbox, and whether to remind you through a notice periodically to organise your inbox.
## Development
This plugin has been developed using Typescript with the Obsidian API and Jest for testing.
Once you've cloned the repository, to speed up plugin development it is recommended to symlink the location of the plugin directly into your local Obsidian:
```bash
ln -s obsidian-inbox-organiser ~/.obsidian/plugins/
```
You can then run the plugin build automatically to pick up any changes:
```bash
npm run dev
```
To test the plugin using Jest, you can run it with or without coverage:
```bash
npm run test
npm run coverage
```
When submitting a PR, the plugin will be automatically tested, and when merged into main this will be built and released using GitHub Actions.