Skip to content

An Obsidian plugin for relay.md. Quick and easy sharing of documents with your team.

License

Notifications You must be signed in to change notification settings

relay-md/relay-md-obsidian-plugin

Repository files navigation

GitHub Release GitHub Actions Workflow Status GitHub Downloads (all assets, all releases) GitHub contributors GitHub last commit GitHub language count GitHub License Mozilla HTTP Observatory Grade GitHub watchers GitHub Repo stars

"Buy Me A Coffee"

Relay.md Obsidian plugin

This repo contains an Obsidian plugin for relay.md.

🎉 The purpose of relay.md is to make sharing markdown files fun again.

Relay.md enables quick and easy sharing of documents with a team and allows to subscribe to individual subjects. Individual team members to share their knowledge with the entire team from within Obsidian.

  • ❌ No more copy&pasting to share a document with your team.
  • ❌ No more changing syntax because your mail client does not support Markdown
  • ❌ No more moving your hands away from keyboard to your mouse
  • ❌ No more looking up email addresses
  • ✅ share your document with the right people in seconds

Finished writing a consultancy contract for business B, have them notified Further, those that deal with different projects, teams or clients, can keep their information aggregated within as single vault and send out their documents to corresponding people from within Obsidian.

🤩 Send specification to the right people in your team using topics. from within Obsidian by sending the docs via relay.md.

🎯 Most importantly, you get to keep your knowledge together!

🏠 Installation

  1. open relay.md plugin in Obsidian
  2. click install
  3. click enable
  4. click configure

🪢 Link your account with relay.md

  1. Open plugin configuration
  2. Click obtain access to relay.md
  3. 🎉 Ready to rumble

📶 Use the Plugin

Using relay.md couldn't be easier with Obsidian. All you need to do is specify the recipient(s) in the frontmatter using:

relay-to:
 - subject@team-name
 - @funnyfriend49
  1. Upon updating the document, the file will be sent to relay.md
  2. Your access credentials are stored in your vault during configuration
  3. As soon as your team mates open up their Obsidian, the relay.md plugin will automatically retrieve all documents that have been created or updated for them.