Skip to content

Commit 4fca65b

Browse files
authored
Merge pull request #9 from obsidian-nvim/chore/update-docs-from-epwalsh
chore/update docs from epwalsh
2 parents 2cbf2ea + 0d9111f commit 4fca65b

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1 align="center">obsidian.nvim</h1>
2-
<div><h4 align="center"><a href="#setup">Setup</a> · <a href="#configuration-options">Configure</a> · <a href="#contributing">Contribute</a> · <a href="https://github.com/epwalsh/obsidian.nvim/discussions">Discuss</a></h4></div>
3-
<div align="center"><a href="https://github.com/epwalsh/obsidian.nvim/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/epwalsh/obsidian.nvim?style=for-the-badge&logo=starship&logoColor=D9E0EE&labelColor=302D41&&color=d9b3ff&include_prerelease&sort=semver" /></a> <a href="https://github.com/epwalsh/obsidian.nvim/pulse"><img alt="Last commit" src="https://img.shields.io/github/last-commit/epwalsh/obsidian.nvim?style=for-the-badge&logo=github&logoColor=D9E0EE&labelColor=302D41&color=9fdf9f"/></a> <a href="https://github.com/neovim/neovim/releases/latest"><img alt="Latest Neovim" src="https://img.shields.io/github/v/release/neovim/neovim?style=for-the-badge&logo=neovim&logoColor=D9E0EE&label=Neovim&labelColor=302D41&color=99d6ff&sort=semver" /></a> <a href="http://www.lua.org/"><img alt="Made with Lua" src="https://img.shields.io/badge/Built%20with%20Lua-grey?style=for-the-badge&logo=lua&logoColor=D9E0EE&label=Lua&labelColor=302D41&color=b3b3ff"></a> <a href="https://www.buymeacoffee.com/epwalsh"><img alt="Buy me a coffee" src="https://img.shields.io/badge/Buy%20me%20a%20coffee-grey?style=for-the-badge&logo=buymeacoffee&logoColor=D9E0EE&label=Sponsor&labelColor=302D41&color=ffff99" /></a></div>
2+
<div><h4 align="center"><a href="#setup">Setup</a> · <a href="#configuration-options">Configure</a> · <a href="#contributing">Contribute</a> · <a href="https://github.com/obsidian-nvim/obsidian.nvim/discussions">Discuss</a></h4></div>
3+
<div align="center"><a href="https://github.com/obsidian-nvim/obsidian.nvim/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/obsidian-nvim/obsidian.nvim?style=for-the-badge&logo=starship&logoColor=D9E0EE&labelColor=302D41&&color=d9b3ff&include_prerelease&sort=semver" /></a> <a href="https://github.com/obsidian-nvim/obsidian.nvim/pulse"><img alt="Last commit" src="https://img.shields.io/github/last-commit/obsidian-nvim/obsidian.nvim?style=for-the-badge&logo=github&logoColor=D9E0EE&labelColor=302D41&color=9fdf9f"/></a> <a href="https://github.com/neovim/neovim/releases/latest"><img alt="Latest Neovim" src="https://img.shields.io/github/v/release/neovim/neovim?style=for-the-badge&logo=neovim&logoColor=D9E0EE&label=Neovim&labelColor=302D41&color=99d6ff&sort=semver" /></a> <a href="http://www.lua.org/"><img alt="Made with Lua" src="https://img.shields.io/badge/Built%20with%20Lua-grey?style=for-the-badge&logo=lua&logoColor=D9E0EE&label=Lua&labelColor=302D41&color=b3b3ff"></a> <a href="https://www.buymeacoffee.com/epwalsh"><img alt="Buy me a coffee" src="https://img.shields.io/badge/Buy%20me%20a%20coffee-grey?style=for-the-badge&logo=buymeacoffee&logoColor=D9E0EE&label=Sponsor&labelColor=302D41&color=ffff99" /></a></div>
44
<hr>
55

66
A Neovim plugin for writing and navigating [Obsidian](https://obsidian.md) vaults, written in Lua.
@@ -116,13 +116,13 @@ Search functionality (e.g. via the `:ObsidianSearch` and `:ObsidianQuickSwitch`
116116
To configure obsidian.nvim you just need to call `require("obsidian").setup({ ... })` with the desired options.
117117
Here are some examples using different plugin managers. The full set of [plugin dependencies](#plugin-dependencies) and [configuration options](#configuration-options) are listed below.
118118

119-
> ⚠️ WARNING: if you install from the latest release (recommended for stability) instead of `main`, be aware that the README on `main` may reference features that haven't been released yet. For that reason I recommend viewing the README on the tag for the [latest release](https://github.com/epwalsh/obsidian.nvim/releases) instead of `main`.
119+
> ⚠️ WARNING: if you install from the latest release (recommended for stability) instead of `main`, be aware that the README on `main` may reference features that haven't been released yet. For that reason I recommend viewing the README on the tag for the [latest release](https://github.com/obsidian-nvim/obsidian.nvim/releases) instead of `main`.
120120
121121
#### Using [`lazy.nvim`](https://github.com/folke/lazy.nvim)
122122

123123
```lua
124124
return {
125-
"epwalsh/obsidian.nvim",
125+
"obsidian-nvim/obsidian.nvim",
126126
version = "*", -- recommended, use latest release instead of latest commit
127127
lazy = true,
128128
ft = "markdown",
@@ -161,7 +161,7 @@ return {
161161

162162
```lua
163163
use({
164-
"epwalsh/obsidian.nvim",
164+
"obsidian-nvim/obsidian.nvim",
165165
tag = "*", -- recommended, use latest release instead of latest commit
166166
requires = {
167167
-- Required.
@@ -774,7 +774,7 @@ And keep in mind that to reset a configuration option to `nil` you'll have to us
774774

775775
## Contributing
776776

777-
Please read the [CONTRIBUTING](https://github.com/epwalsh/obsidian.nvim/blob/main/.github/CONTRIBUTING.md) guide before submitting a pull request.
777+
Please read the [CONTRIBUTING](https://github.com/obsidian-nvim/obsidian.nvim/blob/main/.github/CONTRIBUTING.md) guide before submitting a pull request.
778778

779779
And if you're feeling especially generous I always appreciate some coffee funds! ❤️
780780

scripts/prepare_changelog.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def main():
3030
lines.insert(insert_index, "\n")
3131
lines.insert(
3232
insert_index + 1,
33-
f"## [v{VERSION}](https://github.com/epwalsh/obsidian.nvim/releases/tag/v{VERSION}) - "
33+
f"## [v{VERSION}](https://github.com/obsidian-nvim/obsidian.nvim/releases/tag/v{VERSION}) - "
3434
f"{datetime.now().strftime('%Y-%m-%d')}\n",
3535
)
3636

test/manual/client_spec.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
local obsidian = require "obsidian"
66

7-
local client = obsidian.setup { dir = "~/epwalsh-notes/notes" } ---@diagnostic disable-line: missing-fields
7+
local client = obsidian.setup { dir = "~/obsidian-nvim/notes" } ---@diagnostic disable-line: missing-fields
88
for _, note in ipairs(client:find_notes("allennlp", { search = { sort = false } })) do
99
print(note.id)
1010
end

0 commit comments

Comments
 (0)