The Rust part of the project handles the business logic such as scanning notes via regex or applying changes to notes. It is written to be independent of Obsidian, meaning the plugin could be ported over to other note-taking apps with minimal changes.
The TypeScript part of the project is used create the UI using React. Also, it serves as an accesses point to the Obsidian plugin API to retrieve notes, metadata, etc.
Contributions are welcome, but please make sure they are understandable and no bloat
- Build the project by running
npm run buildin the root directory - To easily copy the build results into your vault, run
npm run build-copyin the root directory- NOTE: Don't forget to:
- change the vault path in
package.jsonto your vault path! - make the copy script executable by running
chmod +x ./copy_to_vault.sh
- change the vault path in
- NOTE: Don't forget to:
- become an official community plugin
- await user feedback on the reliability of the plugin to move out of beta
- caching of scanned notes to improve performance on re scans
- scanning options (e.g. ignore notes, custom regex, etc.)
- multithreading (depends on how WASM develops over time)
- NLP based approach (e.g. "link to notes with similar content")