Skip to content

Commit

Permalink
chore: auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@epwalsh @github-actions
epwalsh authored and github-actions[bot] committed Jul 13, 2023
1 parent 1e7d023 commit 9a9be56
Showing 1 changed file with 123 additions and 121 deletions.
244 changes: 123 additions & 121 deletions doc/obsidian.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ alternatives (see below).

INSTALL AND CONFIGURE ~

Using `lazy.nvim` <https://github.com/folke/lazy.nvim>, for example:
Here are some examples using different plugin managers. The full set of
configuration options are listed |obsidian-below|.


USING LAZY.NVIM

>lua
return {
Expand Down Expand Up @@ -110,102 +114,13 @@ Using `lazy.nvim` <https://github.com/folke/lazy.nvim>, for example:
opts = {
dir = "~/my-vault", -- no need to call 'vim.fn.expand' here

-- Optional, if you keep notes in a specific subdirectory of your vault.
notes_subdir = "notes",

-- Optional, set the log level for Obsidian. This is an integer corresponding to one of the log
-- levels defined by "vim.log.levels.*" or nil, which is equivalent to DEBUG (1).
log_level = vim.log.levels.DEBUG,

daily_notes = {
-- Optional, if you keep daily notes in a separate directory.
folder = "notes/dailies",
-- Optional, if you want to change the date format for daily notes.
date_format = "%Y-%m-%d"
},

-- Optional, completion.
completion = {
-- If using nvim-cmp, otherwise set to false
nvim_cmp = true,
-- Trigger completion at 2 chars
min_chars = 2,
-- Where to put new notes created from completion. Valid options are
-- * "current_dir" - put new notes in same directory as the current buffer.
-- * "notes_subdir" - put new notes in the default notes subdirectory.
new_notes_location = "current_dir"
},

-- Optional, customize how names/IDs for new notes are created.
note_id_func = function(title)
-- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
-- In this case a note with the title 'My new note' will given an ID that looks
-- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
local suffix = ""
if title ~= nil then
-- If title is given, transform it into valid file name.
suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
else
-- If title is nil, just add 4 random uppercase letters to the suffix.
for _ = 1, 4 do
suffix = suffix .. string.char(math.random(65, 90))
end
end
return tostring(os.time()) .. "-" .. suffix
end,

-- Optional, set to true if you don't want Obsidian to manage frontmatter.
disable_frontmatter = false,

-- Optional, alternatively you can customize the frontmatter data.
note_frontmatter_func = function(note)
-- This is equivalent to the default frontmatter function.
local out = { id = note.id, aliases = note.aliases, tags = note.tags }
-- `note.metadata` contains any manually added fields in the frontmatter.
-- So here we just make sure those fields are kept in the frontmatter.
if note.metadata ~= nil and require("obsidian").util.table_length(note.metadata) > 0 then
for k, v in pairs(note.metadata) do
out[k] = v
end
end
return out
end,

-- Optional, for templates (see below).
templates = {
subdir = "templates",
date_format = "%Y-%m-%d-%a",
time_format = "%H:%M",
},

-- Optional, by default when you use `:ObsidianFollowLink` on a link to an external
-- URL it will be ignored but you can customize this behavior here.
follow_url_func = function(url)
-- Open the URL in the default web browser.
vim.fn.jobstart({"open", url}) -- Mac OS
-- vim.fn.jobstart({"xdg-open", url}) -- linux
end,

-- Optional, set to true if you use the Obsidian Advanced URI plugin.
-- https://github.com/Vinzent03/obsidian-advanced-uri
use_advanced_uri = true,

-- Optional, set to true to force ':ObsidianOpen' to bring the app to the foreground.
open_app_foreground = false,

-- Optional, by default commands like `:ObsidianSearch` will attempt to use
-- telescope.nvim, fzf-lua, and fzf.nvim (in that order), and use the
-- first one they find. By setting this option to your preferred
-- finder you can attempt it first. Note that if the specified finder
-- is not installed, or if it the command does not support it, the
-- remaining finders will be attempted in the original order.
finder = "telescope.nvim",
-- see below for full list of options 👇
},
config = function(_, opts)
require("obsidian").setup(opts)

-- Optional, override the 'gf' keymap to utilize Obsidian's search functionality.
-- see also: 'follow_url_func' config option above.
-- see also: 'follow_url_func' config option below.
vim.keymap.set("n", "gf", function()
if require("obsidian").util.cursor_on_markdown_link() then
return "<cmd>ObsidianFollowLink<CR>"
Expand All @@ -217,37 +132,124 @@ Using `lazy.nvim` <https://github.com/folke/lazy.nvim>, for example:
}
<

Basic setup using `packer.nvim` <https://github.com/wbthomason/packer.nvim>:

USING PACKER.NVIM

>lua
use({
"epwalsh/obsidian.nvim",
config = function()
require("obsidian").setup({
use_advanced_uri = true,
dir = "~/path/to/my-vault",
daily_notes = {
folder = "dailies",
},
completion = {
nvim_cmp = true,
},
note_id_func = function(title)
local sane_name = ""
if title ~= nil then
-- If title is given, transform it into valid file name.
sane_name = title:gsub(" ", "_"):gsub("[^A-Za-z0-9-]", ""):lower()
else
-- If title is nil, just add 4 random uppercase letters to the suffix.
for _ in 1, 4 do
sane_name = sane_name .. string.char(math.random(65, 90))
end
end
return sane_name
end,
})
end,
})
use({
"epwalsh/obsidian.nvim",
config = function()
require("obsidian").setup({
dir = "~/my-vault",

-- see below for full list of options 👇
})
end,
})
<


CONFIGURATION OPTIONS

This is a complete list of all of the options that can be passed to
`require("obsidian").setup()`:

>lua
{
-- Required, the path to your vault directory.
dir = "~/my-vault",

-- Optional, if you keep notes in a specific subdirectory of your vault.
notes_subdir = "notes",

-- Optional, set the log level for Obsidian. This is an integer corresponding to one of the log
-- levels defined by "vim.log.levels.*" or nil, which is equivalent to DEBUG (1).
log_level = vim.log.levels.DEBUG,

daily_notes = {
-- Optional, if you keep daily notes in a separate directory.
folder = "notes/dailies",
-- Optional, if you want to change the date format for daily notes.
date_format = "%Y-%m-%d"
},

-- Optional, completion.
completion = {
-- If using nvim-cmp, otherwise set to false
nvim_cmp = true,
-- Trigger completion at 2 chars
min_chars = 2,
-- Where to put new notes created from completion. Valid options are
-- * "current_dir" - put new notes in same directory as the current buffer.
-- * "notes_subdir" - put new notes in the default notes subdirectory.
new_notes_location = "current_dir"
},

-- Optional, customize how names/IDs for new notes are created.
note_id_func = function(title)
-- Create note IDs in a Zettelkasten format with a timestamp and a suffix.
-- In this case a note with the title 'My new note' will given an ID that looks
-- like '1657296016-my-new-note', and therefore the file name '1657296016-my-new-note.md'
local suffix = ""
if title ~= nil then
-- If title is given, transform it into valid file name.
suffix = title:gsub(" ", "-"):gsub("[^A-Za-z0-9-]", ""):lower()
else
-- If title is nil, just add 4 random uppercase letters to the suffix.
for _ = 1, 4 do
suffix = suffix .. string.char(math.random(65, 90))
end
end
return tostring(os.time()) .. "-" .. suffix
end,

-- Optional, set to true if you don't want Obsidian to manage frontmatter.
disable_frontmatter = false,

-- Optional, alternatively you can customize the frontmatter data.
note_frontmatter_func = function(note)
-- This is equivalent to the default frontmatter function.
local out = { id = note.id, aliases = note.aliases, tags = note.tags }
-- `note.metadata` contains any manually added fields in the frontmatter.
-- So here we just make sure those fields are kept in the frontmatter.
if note.metadata ~= nil and require("obsidian").util.table_length(note.metadata) > 0 then
for k, v in pairs(note.metadata) do
out[k] = v
end
end
return out
end,

-- Optional, for templates (see below).
templates = {
subdir = "templates",
date_format = "%Y-%m-%d-%a",
time_format = "%H:%M",
},

-- Optional, by default when you use `:ObsidianFollowLink` on a link to an external
-- URL it will be ignored but you can customize this behavior here.
follow_url_func = function(url)
-- Open the URL in the default web browser.
vim.fn.jobstart({"open", url}) -- Mac OS
-- vim.fn.jobstart({"xdg-open", url}) -- linux
end,

-- Optional, set to true if you use the Obsidian Advanced URI plugin.
-- https://github.com/Vinzent03/obsidian-advanced-uri
use_advanced_uri = true,

-- Optional, set to true to force ':ObsidianOpen' to bring the app to the foreground.
open_app_foreground = false,

-- Optional, by default commands like `:ObsidianSearch` will attempt to use
-- telescope.nvim, fzf-lua, and fzf.nvim (in that order), and use the
-- first one they find. By setting this option to your preferred
-- finder you can attempt it first. Note that if the specified finder
-- is not installed, or if it the command does not support it, the
-- remaining finders will be attempted in the original order.
finder = "telescope.nvim",
}
<

**❗ Notes**
Expand Down

0 comments on commit 9a9be56

Please sign in to comment.