Discord Share Plugin

This plugin allows you to share your Obsidian Vault content to Discord using discord.js.

Note

Neither this plugin nor its authors are associated with Discord.

Discord Share Plugin

Setup

Install the Plugin
Enable it.
Get a Webhook URL from Discord. See this guide for more on how to do this.
Paste your Discord Webhook URL into the Discord Webhook URL setting for this plugin. You must do this or the plugin will not work.
(Optional) Add more webhooks (you'll be prompted for which to use during each command).

Install the Plugin

You have two options for installing the plugin.

Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/obsidian-discord-share/.
Use the Obsidian BRAT plugin (recommended).

Optional Settings

You can customize the username that appears for the Discord bot by updating the Custom Discord Bot Username setting.
You can customize the avatar that appears for the Discord bot by updating the Custom Discord Bot Avatar setting. This requires the URL of an image.
By default, the plugin will search all files for attachments. You can choose which folder to look for attachments in by updating the Attachments folder setting. If you set this, the plugin will only search that folder and all folders within it.
You can turn on/off image previews in the local image search by adjusting the Show preview images setting.
You can change the number of suggestions to show in the local image search by changing the Suggestions limit setting.
You can override the default frontmatter properties for embeds (see Example Frontmatter below) to use your own values.

Features

Open the command palette and search for Share Attachment to Discord. Click on it or press return on your keyboard. This opens a modal to search your local image files. Search for the file you want and click on it or press return on your keyboard.

Share Current Note to Discord (Properties)

Open the command palette and search for Share Current Note to Discord (Properties). Click on it or press return on your keyboard. This option will not show in the menu if you don't have a note open.

This feature parses YAML frontmatter (properties) for the current note and shares it to Discord in a formatted embed. It's a great way to share prepared information with images and links. You can configure in Settings which frontmatter fields (properties) map to which pieces of a Discord embed or use the defaults below.

Example Properties

ods-color: '#8D59D7' # If provided, this will override the `Embed Color` setting in the plugin's settings tab. 
ods-title: Discord Share
ods-url: 'https://github.com/phd20/obsidian-discord-share'
ods-author:
  name: PhD20
  iconURL: 'https://avatars.githubusercontent.com/u/33853403'
  url: 'https://github.com/phd20'
ods-description: >-
  This plugin allows you to share your Obsidian Vault content to Discord
ods-thumbnail-url: 'https://avatars.githubusercontent.com/u/65011256'
ods-fields: # You can add or remove fields. 
  - name: Version
    value: 1.2.0
    inline: true
  - name: Install
    value: Ready
    inline: true
  - name: Awesome?
    value: Yes
    inline: true
ods-image: https://user-images.githubusercontent.com/33853403/200464422-a66e62ee-08c9-4e75-bdc2-9bd585cef2ab.png # This can be a URL or a link to an image in your vault: [[image.png]]. NOTE: embeds will not properly attach the image from your vault if it has spaces in the name. Example: [[image name.png]]
ods-footer:
  text: Build using discord.js
  iconURL: 'https://avatars.githubusercontent.com/u/26492485'

Share Selection to Discord

Open a file editor and select (highlight) any text. You can send this text to Discord in one of two ways:

Open the command palette and search for Share Selection to Discord. Click on it or press return on your keyboard.
Right-click on your selection to open the context menu. Choose Share selection to Discord.

Share Current Note to Discord (Content)

Open the command palette and search for Share Current Note to Discord (Content). Click on it or press return on your keyboard. This option will not show in the menu if you don't have a note open.

This feature uses the title and main content body for the current note and shares it to Discord in a formatted embed. It's a great way to share raw text content. For now, it will try to format your markdown content in the following ways:

Removes frontmatter (properties)
Removes Obsidian comments (%% This would be removed %%)
Replaces link aliases ([[Link|Alias]] becomes Alias)
Replaces wiki links ([[Link]] becomes Link)

Future enhancements are planned for more sophisticated formatting (ex. images, markdown links, etc).

phd20 / obsidian-discord-share