Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/praczet/note-tags.nvim
https://github.com/praczet/note-tags.nvim
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/praczet/note-tags.nvim
- Owner: Praczet
- Created: 2023-04-12T18:42:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-25T08:53:09.000Z (6 months ago)
- Last Synced: 2024-12-08T19:39:05.624Z (18 days ago)
- Language: Lua
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# note-tags
This plugin is **deprecated** which means I won't change anything.. There is a simillar plugin that I wrote, doing the same, by instead keeping tags in #tag format it keeps them in YAML section, tags:
See: [yaml-tags.nvim](https://github.com/Praczet/yaml-tags.nvim)
And this is my only the second plugin for neovim (or rather for LunarVim) and also my second script in lua so... Do not hit, just explain!
## Introduction
The main idea behind this plugin is to be able go thru #tags (just words with the # at the beginning) that are added in my notes file.
As I was not able to make a decision which approach to take for searching for tags I created for both (separator | wholeFile)
- **Separator** - is a model where `note-tags` gets tags from file after a line with separator.
- **wholeFile** - is a model where `note-tags` gets tags from file not matter where they appear
General usage if this plugin could be described as:
- Displaying list of tags `:Tags`
- Displaying list of notes `:Notes`
- Adding tags to current buffer (from previewer ``)
- Displaying Notes for a selected tag (from previewer ``)
- Adding new tag (from previewer ``)
## Installation (not ready)
## Configuration
You can configure:
- **notes_folder** - Folder with notes, if you sets it as '' it will take current working folder
- **read_tag_method** - Method how plugin reads tags:
- **_separator_** - it will reads tags after line with separator
- **_wholeFile_** - it will looks for tags in file
- **tags_separator** - separator default: it is needed when read_tag_method = seperator
```lua
{
"Praczet/note-tags.nvim",
config = function()
require("note-tags").setup({
notes_folder = "~/Notes", -- optional (default: current folder)
read_tag_method = "separator", -- optional (default: separator)
separator = "", -- optional (default: )
})
end
}
```
## Usage
### Displaying all notes
To display all notes from the folder and be able to preview then with glow:
`:Notes` or `nn`
If glow is not isnatlled a note will be just displayed wuth `cat`
### Displaying Tags
To display all Tags' list:
`:Tags` or `nt`
In the previewer will be displayed a list of notes for selected tag.
From this place you can:
1. Enter a tag to buffer `` - will add selected tag
2. Enter a new tag to buffer `` - adds a new tag based on input in finder
3. Display list of notes for selected tag ``
### Displaying Notes for selected tag
from this place you can
1. Open Selected Note ``
2. Go back to tags' list ``
### Added tags in the Note
By default (if method is set for "separator") and separator = `` you can see tags at the bottom of note.
From the buffer in normal mode you can add a new note by `na`
## ToDo
- [x] Change behavior of enter in Picker instead of closing should stay open
- [x] Add Mapping for control + O to open notes filtered by tag
- [x] Add reading data from config, which I have no Idea how
- [x] Add Mapping for leader n
- [x] Add mapping for `` to create new tag
- [x] Add mapping for `` - Tags
- [x] Add mapping for `` - Notes
- [ ] Add proper way to name Group (for `n`)
- [ ] Add it as extension of Telescope
- [ ] Fill this file (README.md)
- [x] Introduction
- [ ] Installation
- [x] Screenshots
- [x] Usage
[^1]: Folder should be or declared in config or plugin will take current one.