Skip to content

Commit

Permalink
docs: updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
IlyasYOY committed Sep 5, 2023
1 parent 59a7934 commit 6d77193
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,15 @@ I won't go over all configuration options in details. There are the most importa
Example mappings configuration may be found [here](https://github.com/IlyasYOY/dotfiles/blob/master/config/nvim/lua/plugins/obs.lua).

- *Insert template using telescope.* `:ObsNvimTemplate` opens dialog with `<CR>` mapped to insert template in the line below.
- *Follow link under cursor.* `:ObsNvimFollowLink`
- *Follow link under cursor.* `:ObsNvimFollowLink`.
- *Open random note.* `:ObsNvimRandomNote`.
- *Creates a new note.* `:ObsNvimNewNote` prefixes note with `YYYY-MM-dd`. In case of empty name plugin generates name from time-stamp. Example: `2023-03-12 1678625141.md`.
- *Opens daily note.* `:ObsNvimDailyNote` creates one if doesn't exist.
- *Telescope find notes.* `:ObsNvimFindNote`
- *Telescope find journal notes.* `:ObsNvimFindInJournal`
- *Telescope live-grep through notes.* `:ObsNvimFinInNotes`
- *Telescope through back-links.* `:ObsNvimBacklinks`
- *Renames current note.* `:ObsNvimRename` updates links to the note. I advice you to rename notes inside **Obsidian** for important notes with lots of back-links.
- *Telescope find notes.* `:ObsNvimFindNote`.
- *Telescope find journal notes.* `:ObsNvimFindInJournal`.
- *Telescope live-grep through notes.* `:ObsNvimFinInNotes`.
- *Telescope through back-links.* `:ObsNvimBacklinks`.
- *Renames current note.* `:ObsNvimRename` updates links to the note. I advice you to rename notes inside **Obsidian** for important notes with lots of back-links.
- *Move note to directory from search.* `:ObsNvimMove` launches telescope to find directory to move current note to.
- *Setup nvim-cmp completion source.* After that you'll be able to use completion for notes inside your vault.

Expand Down

0 comments on commit 6d77193

Please sign in to comment.