Skip to content

Commit 5b3cbe2

Browse files
guspixgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent 405e35f commit 5b3cbe2

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

doc/obsidian.txt

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
obsidian.nvim
44

5-
A Neovim plugin for writing and navigating Obsidian <https://obsidian.md>
6-
vaults, written in Lua.
5+
A **community fork** of the Neovim plugin for writing and navigating Obsidian
6+
<https://obsidian.md> vaults, written in Lua, created by epwalsh
7+
<https://github.com/epwalsh>.
78

89
Built for people who love the concept of Obsidian – a simple, markdown-based
910
notes app – but love Neovim too much to stand typing characters into anything
1011
else.
1112

12-
If you’re new to Obsidian I highly recommend watching this excellent YouTube
13+
If you’re new to Obsidian we highly recommend watching this excellent YouTube
1314
video <https://youtu.be/5ht8NYkU9wQ?si=8nbnNsRVnw0xfX2S> for a great overview.
1415

1516
_Keep in mind this plugin is not meant to replace Obsidian, but to complement
@@ -20,7 +21,20 @@ own as well. You don’t necessarily need to use it alongside the Obsidian app.
2021

2122

2223
==============================================================================
23-
1. Table of contents *obsidian-table-of-contents*
24+
1. About the fork *obsidian-about-the-fork*
25+
26+
The original project has not been actively maintained for quite a while and
27+
with the ever-changing Neovim ecosystem, new widely used tools such as
28+
blink.cmp <https://github.com/Saghen/blink.cmp> or snacks.picker
29+
<https://github.com/folke/snacks.nvim/blob/main/docs/picker.md> were not
30+
supported. With bugs, issues and pull requests piling up, people from the
31+
community decided to fork and maintain the project. The fork aims to stay close
32+
to the original, but fix bugs, include and merge useful improvements, and
33+
ensure long term robustness.
34+
35+
36+
==============================================================================
37+
2. Table of contents *obsidian-table-of-contents*
2438

2539
- 👉 |obsidian-features|
2640
- |obsidian-commands|
@@ -37,7 +51,7 @@ own as well. You don’t necessarily need to use it alongside the Obsidian app.
3751

3852

3953
==============================================================================
40-
2. Features *obsidian-features*
54+
3. Features *obsidian-features*
4155

4256
▶️ **Completion:** Ultra-fast, asynchronous autocompletion for note
4357
references and tags via nvim-cmp <https://github.com/hrsh7th/nvim-cmp> or
@@ -130,7 +144,7 @@ DEMO *obsidian-demo*
130144

131145

132146
==============================================================================
133-
3. Setup *obsidian-setup*
147+
4. Setup *obsidian-setup*
134148

135149

136150
SYSTEM REQUIREMENTS *obsidian-system-requirements*
@@ -910,24 +924,26 @@ option to `nil` you’ll have to use `vim.NIL` there instead of the builtin Lua
910924

911925

912926
==============================================================================
913-
4. Contributing *obsidian-contributing*
927+
5. Contributing *obsidian-contributing*
914928

915929
Please read the CONTRIBUTING
916930
<https://github.com/obsidian-nvim/obsidian.nvim/blob/main/.github/CONTRIBUTING.md>
917931
guide before submitting a pull request.
918932

919-
And if you’re feeling especially generous I always appreciate some coffee
920-
funds! ❤️
921933

922-
<https://www.buymeacoffee.com/epwalsh>
934+
==============================================================================
935+
6. Acknowledgement *obsidian-acknowledgement*
936+
937+
We would like to thank epwalsh <https://github.com/epwalsh> for creating this
938+
beautiful plugin. If you’re feeling especially generous, he still appreciates
939+
some coffee funds! ❤️ <https://www.buymeacoffee.com/epwalsh>.
923940

924941
==============================================================================
925-
5. Links *obsidian-links*
942+
7. Links *obsidian-links*
926943

927944
1. *See this screenshot*: https://github.com/epwalsh/obsidian.nvim/assets/8812459/90d5f218-06cd-4ebb-b00b-b59c2f5c3cc1
928945
2. *See this screenshot*: https://github.com/epwalsh/obsidian.nvim/assets/8812459/e74f5267-21b5-49bc-a3bb-3b9db5fa6687
929946
3. *2024-01-31 14 22 52*: https://github.com/epwalsh/obsidian.nvim/assets/8812459/2986e1d2-13e8-40e2-9c9e-75691a3b662e
930-
4. *BuyMeACoffee*: https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
931947

932948
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
933949

0 commit comments

Comments
 (0)