lostpaul_obsidian-folder-notes/README.md

52 lines
2.7 KiB
Markdown
Raw Normal View History

2023-03-22 11:38:29 +00:00
# Obsidian folder notes
Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.
2023-05-19 19:39:52 +00:00
## Support the development of the plugin
<a href='https://ko-fi.com/D1D1GHGSI' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
2023-03-22 11:38:29 +00:00
## Table of contents
- [Features](#features)
2023-03-22 11:54:11 +00:00
- [Credits](#credits)
2023-03-23 09:38:39 +00:00
- [Showcase](#showcase)
2023-03-23 09:26:09 +00:00
- [How to install the plugin](#how-to-install-the-plugin)
2023-03-22 11:38:29 +00:00
## Features
- Notes in folders
- Click on folder name to open folder note
- Folders don't collapse (can be changed in the settings)
- Templater and templates support
- The name of folders that contain folder notes are underlined (can get toggled in the settings)
2023-03-23 08:24:13 +00:00
- Automatically create folder notes in folder on folder creation (can be turned on in the settings)
2023-03-22 11:38:29 +00:00
- Exclude folders
2023-03-23 08:24:13 +00:00
- Hide folder notes from file explorer
2023-03-23 09:20:06 +00:00
#### Soon
2023-03-23 09:04:44 +00:00
- Create folder note for every existing folder
2023-03-23 09:20:06 +00:00
2023-03-23 09:38:39 +00:00
## Showcase
2023-03-23 10:45:30 +00:00
#### Open folder notes
2023-03-23 10:02:03 +00:00
![wzk25GXUpc](https://user-images.githubusercontent.com/70213368/227169041-9bc7552e-c5f5-4001-94d9-b4c80ea88bd1.gif)
2023-03-23 09:38:39 +00:00
2023-03-23 10:45:30 +00:00
#### Automatically create folder notes
2023-03-23 10:04:12 +00:00
![Obsidian_NLUDzVBWRe](https://user-images.githubusercontent.com/70213368/227169603-3a105622-e6cb-4889-a709-acf52ad06d6e.gif)
2023-03-23 09:26:09 +00:00
## How to install the plugin
2023-03-23 09:20:06 +00:00
1. Download main.js, manifest.json, styles.css from the latest release (see [releases](https://github.com/LostPaul/obsidian-folder-notes/releases/))
2. Create a new folder in `Vault-name/.obsidian/plugins` and put the downloaded files in there
3. Reload your plugins and enable the plugin
2023-03-23 09:25:34 +00:00
<img width="585" alt="Obsidian_QaY1e3nCzL" src="https://user-images.githubusercontent.com/70213368/227159411-5a2b0a99-f612-42f2-bc57-4f0a7f97d65e.png">
<img width="582" alt="Obsidian_w4hTprcOjW" src="https://user-images.githubusercontent.com/70213368/227159064-e116ea0c-c249-4750-9b0f-b010e4a6afc5.png">
2023-03-12 16:11:05 +00:00
2023-03-22 11:50:24 +00:00
## Credits
Thank you to everyone who has created a plugin that inspired me and I took code from.
2023-03-23 08:25:27 +00:00
- Template suggester, created by [SilentVoid13](https://github.com/SilentVoid13) and [Liamcain](https://github.com/liamcain) (their plugins: [Templater](https://github.com/SilentVoid13/Templater/), [Periodic notes](https://github.com/liamcain/obsidian-periodic-notes))
2023-03-23 08:24:13 +00:00
- Apply template to note, first seen in https://github.com/mgmeyers/obsidian-kanban/ from [Mgmeyers](https://github.com/mgmeyers)
- Folder underline, inspired from https://github.com/aidenlx/alx-folder-note
- Stop folders from collapsing, the basic idea from https://github.com/alangrainger/obsidian-folder-notes and some code lines
- The basic idea is from https://github.com/xpgo/obsidian-folder-note-plugin