Skip to content

Commit 87d7b4e

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

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

doc/obsidian.txt

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,12 @@ managers. The full set of |obsidian-plugin-dependencies| and
168168

169169
USING LAZY.NVIM ~
170170

171+
Click for install snippet ~
172+
171173
>lua
172174
return {
173175
"obsidian-nvim/obsidian.nvim",
174-
version = "*", -- recommended, use latest release instead of latest commit
176+
version = "*", -- recommended, use latest release instead of latest commit
175177
lazy = true,
176178
ft = "markdown",
177179
-- Replace the above line with this if you only want to load obsidian.nvim for markdown files in your vault:
@@ -206,20 +208,33 @@ USING LAZY.NVIM ~
206208
<
207209

208210

211+
USING ROCKS.NVIM ~
212+
213+
Click for install snippet ~
214+
215+
>vim
216+
:Rocks install obsidian
217+
<
218+
219+
209220
USING PACKER.NVIM ~
210221

222+
It is not recommended because packer.nvim is currently unmaintained
223+
224+
Click for install snippet ~
225+
211226
>lua
212-
use({
227+
use {
213228
"obsidian-nvim/obsidian.nvim",
214-
tag = "*", -- recommended, use latest release instead of latest commit
229+
tag = "*", -- recommended, use latest release instead of latest commit
215230
requires = {
216231
-- Required.
217232
"nvim-lua/plenary.nvim",
218233

219234
-- see below for full list of optional dependencies 👇
220235
},
221236
config = function()
222-
require("obsidian").setup({
237+
require("obsidian").setup {
223238
workspaces = {
224239
{
225240
name = "personal",
@@ -232,9 +247,9 @@ USING PACKER.NVIM ~
232247
},
233248

234249
-- see below for full list of options 👇
235-
})
250+
}
236251
end,
237-
})
252+
}
238253
<
239254

240255

@@ -246,20 +261,26 @@ dependencies that enhance the obsidian.nvim experience.
246261

247262
**Completion:**
248263

249-
- **[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.
264+
- **[recommended]** hrsh7th/nvim-cmp <https://github.com/hrsh7th/nvim-cmp>
265+
- blink.cmp <https://github.com/Saghen/blink.cmp> (new)
251266

252267
**Pickers:**
253268

254-
- **[recommended]** nvim-telescope/telescope.nvim <https://github.com/nvim-telescope/telescope.nvim>: for search and quick-switch functionality.
255-
- Mini.Pick <https://github.com/echasnovski/mini.pick> from the mini.nvim library: an alternative to telescope for search and quick-switch functionality.
256-
- ibhagwan/fzf-lua <https://github.com/ibhagwan/fzf-lua>: another alternative to telescope for search and quick-switch functionality.
257-
- Snacks.Picker <https://github.com/folke/snacks.nvim/blob/main/docs/picker.md> from the snacks.nvim library: an alternative to mini and telescope for search and quick-switch functionality.
269+
- **[recommended]** nvim-telescope/telescope.nvim <https://github.com/nvim-telescope/telescope.nvim>
270+
- ibhagwan/fzf-lua <https://github.com/ibhagwan/fzf-lua>
271+
- Mini.Pick <https://github.com/echasnovski/mini.pick> from the mini.nvim library
272+
- Snacks.Picker <https://github.com/folke/snacks.nvim/blob/main/docs/picker.md> from the snacks.nvim library
258273

259274
**Syntax highlighting:**
260275

261-
- **[recommended]** nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>: for base markdown syntax highlighting. See |obsidian-syntax-highlighting| for more details.
262-
- preservim/vim-markdown <https://github.com/preservim/vim-markdown>: an alternative to nvim-treesitter for syntax highlighting (see |obsidian-syntax-highlighting| for more details), plus other cool features.
276+
See |obsidian-syntax-highlighting| for more details.
277+
278+
- For base syntax highlighting:
279+
- **[recommended]** nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>
280+
- preservim/vim-markdown <https://github.com/preservim/vim-markdown>
281+
- For additional syntax features:
282+
- render-markdown.nvim <https://github.com/MeanderingProgrammer/render-markdown.nvim>
283+
- markview.nvim <https://github.com/OXY2DEV/markview.nvim>
263284

264285
**Miscellaneous:**
265286

@@ -626,7 +647,7 @@ the `workspaces` field in your config would look like this:
626647
name = "personal",
627648
path = "~/vaults/personal",
628649
},
629-
}
650+
},
630651
}
631652
<
632653

@@ -658,7 +679,7 @@ example:
658679
-- ...
659680
},
660681
},
661-
}
682+
},
662683
}
663684
<
664685

@@ -677,7 +698,7 @@ buffer:
677698
return assert(vim.fs.dirname(vim.api.nvim_buf_get_name(0)))
678699
end,
679700
},
680-
}
701+
},
681702
}
682703
<
683704

@@ -707,12 +728,12 @@ you’re configuration should include both "markdown" and "markdown_inline"
707728
sources:
708729

709730
>lua
710-
require("nvim-treesitter.configs").setup({
731+
require("nvim-treesitter.configs").setup {
711732
ensure_installed = { "markdown", "markdown_inline", ... },
712733
highlight = {
713734
enable = true,
714735
},
715-
})
736+
}
716737
<
717738

718739
If you use `vim-markdown` you’ll probably want to disable its frontmatter

0 commit comments

Comments
 (0)