Skip to content

dhurley94/obsidian-giphy-plugin

Repository files navigation

Obsidian Giphy Plugin

This is a the most important plugin for Obsidian (https://obsidian.md).

This project uses Typescript to provide type checking and documentation.

Generate an API Key

Create an API key and add it to the plugin configuration. https://developers.giphy.com/dashboard/?create=true

Usage

Set the API Key:

Before using the plugin, you'll need to set your Giphy API key. In Settings, find your Giphy plugin in the list of installed plugins and click on its settings (there should be a "settings" option or a gear icon next to your plugin). Enter your Giphy API key in the provided input box and save it. Use the Command to Insert a GIF:

Open or create a note where you want to insert the GIF. Open the command palette with `Ctrl/Cmd + P``. Type in and select the command associated with your plugin, which should be something like "Search Giphy for GIFs" based on the code we discussed. A modal dialog will appear prompting you to enter a keyword for the GIF search. Enter a keyword (e.g., "happy") and press the "Search" button. If a GIF is found, it will be inserted at the current cursor position in your note as a markdown image link. View the GIF:

To view the GIF in your note, you'll need to be in preview mode. Toggle between edit and preview mode using `Ctrl/Cmd + E``.

Install

cd your/vault/document/path/
mkdir -p .obsidian/plugins
git clone https://github.com/dhurley94/obsidian-giphy-plugin.git