https://github.com/coldmayo/obsidian-kak

Kakoune plugin for Obsidian integration
https://github.com/coldmayo/obsidian-kak

kakoune kakoune-plugin obsidian obsidian-md plugin

Last synced: about 1 month ago
JSON representation

Kakoune plugin for Obsidian integration

• Host: GitHub
• URL: https://github.com/coldmayo/obsidian-kak
• Owner: coldmayo
• Created: 2024-06-25T15:04:09.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-09T05:14:54.000Z (3 months ago)
• Last Synced: 2024-10-14T07:22:43.567Z (about 1 month ago)
• Topics: kakoune, kakoune-plugin, obsidian, obsidian-md, plugin
• Language: C
• Homepage:
• Size: 10.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Obsidian-kak

This is a Kakoune plugin for using Obsidian vaults. I want this to be used in a similar way to [obsidian.nvim](https://github.com/epwalsh/obsidian.nvim). This is a plugin I use personally for my own notetaking. I hope this will be useful to others as well. If you have any suggestions, don't be scared to submit an issue.

## Installation

To add this plugin all you have to do is

1. Ensure you have the GCC installed

2. Clone this repo into your plugins directory

3. and then add the following to your kakrc:

```bash

source ~/.config/kak/plugins/Obsidian-kak/Obsidian-kak.kak do sh%{

	cd ~/.config/kak/plugins/Obsidian-kak

	gcc -o main main.c	

}

```

## Commands

- ```:is-obsidian-vault ```: checks if current directory is an Obsidian vault

- ```:open-note [TITLE]```: used to create a new note. It has one arguement required, which is the name of the new markdown file (without the .md file extention)

	- Example use: ```:open-note CookieRecipe```

- ```:paste-img [FILE]```: puts most recently copied image into the markdown file defined in the arguement. The copied image will be saved to a folder named "assets". This is dependant on wl-clipboard.

	- Example use: ```:paste-img 'CookieRecipe.md'```

- ```:create-all-mds [FILE]```: this command finds out if all of the links in the given note is a file in the vault, if it is not the file will be created

	- Example use: ```:create-all-mds 'CookieRecipe.md'```

- ```:open-obsidian```: opens the currently opened vault in Obsidian

- ```:note-in-app [FILE]```: opens the given file in the currently opened vault

	- Example use: ```:note-in-app "CookieRecipe.md"```

- ```:move-note [FILE] [DIRECTORY]```: Moves the file (given by argument 1) to a directory (given by argument 2)

	- Example use: ```:move-note 'CookieRecipe.md' 'All Recipes/'```

- ```:create-table [FILE]```: Creates a table in the given file (argument 1)

	- Example use: ```:create-table 'CookieRecipie.md'```

There is more to come, I am not close to being done developing this.