Skip to content

Commit e0c781e

Browse files
guspixgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent a78fb6d commit e0c781e

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

doc/obsidian.txt

+13-7
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ own as well. You don’t necessarily need to use it alongside the Obsidian app.
4040
2. Features *obsidian-features*
4141

4242
▶️ **Completion:** Ultra-fast, asynchronous autocompletion for note
43-
references and tags via nvim-cmp <https://github.com/hrsh7th/nvim-cmp>
44-
(triggered by typing `[[` for wiki links, `[` for markdown links, or `#` for
45-
tags), powered by `ripgrep` <https://github.com/BurntSushi/ripgrep>.
43+
references and tags via nvim-cmp <https://github.com/hrsh7th/nvim-cmp> or
44+
blink.cmp <https://github.com/Saghen/blink.cmp> (triggered by typing `[[` for
45+
wiki links, `[` for markdown links, or `#` for tags), powered by `ripgrep`
46+
<https://github.com/BurntSushi/ripgrep>.
4647

4748

4849
<https://github.com/epwalsh/obsidian.nvim/assets/8812459/90d5f218-06cd-4ebb-b00b-b59c2f5c3cc1>
@@ -246,6 +247,7 @@ dependencies that enhance the obsidian.nvim experience.
246247
**Completion:**
247248

248249
- **[recommended]** hrsh7th/nvim-cmp <https://github.com/hrsh7th/nvim-cmp>: for completion of note references.
250+
- blink.cmp <https://github.com/Saghen/blink.cmp> (new): for completion of note references.
249251

250252
**Pickers:**
251253

@@ -322,8 +324,10 @@ carefully and customize it to your needs:
322324

323325
-- Optional, completion of wiki links, local markdown links, and tags using nvim-cmp.
324326
completion = {
325-
-- Set to false to disable completion.
327+
-- Enables completion using nvim_cmp
326328
nvim_cmp = true,
329+
-- Enables completion using blink.cmp
330+
blink = false,
327331
-- Trigger completion at 2 chars.
328332
min_chars = 2,
329333
},
@@ -683,9 +687,11 @@ plugin’s functionality on markdown files outside of your "fixed" vaults. See
683687

684688
COMPLETION ~
685689

686-
obsidian.nvim will set itself up as an nvim-cmp source automatically when you
687-
enter a markdown buffer within your vault directory, you do **not** need to
688-
specify this plugin as a cmp source manually.
690+
obsidian.nvim supports nvim_cmp and blink.cmp completion plugins.
691+
692+
obsidian.nvim will set itself up automatically when you enter a markdown buffer
693+
within your vault directory, you do **not** need to specify this plugin as a
694+
cmp source manually.
689695

690696
Note that in order to trigger completion for tags _within YAML frontmatter_ you
691697
still need to type the "#" at the start of the tag. obsidian.nvim will remove

0 commit comments

Comments
 (0)