Relay Comments

by Relay.md
5
4
3
2
1
Score: 50/100

Description

Add comments and suggested edits to Relay in Obsidian

Reviews

No reviews yet.

Stats

4
stars
1,652
downloads
2
forks
100
days
3
days
3
days
8
total PRs
1
open PRs
6
closed PRs
1
merged PRs
2
total issues
0
open issues
2
closed issues
172
commits

Latest Version

4 days ago

Changelog

Relay Comments 0.6.0 lets you comment on text selected inside a rendered callout and keeps block syntax out of comment anchors.

Features

  • Comment on text selected in a rendered callout in Live Preview. The selection maps back to the callout's source; selections that span the title and body, a link label or a code span are declined. Contributed by Peter Gaultney.

Fixes

  • Keep a callout's [!type] marker outside the highlight when the whole title line is selected, so the block still renders as a callout. Contributed by Peter Gaultney.
  • Keep closing heading hashes outside the highlight, and decline a selection that runs into a later list, quote or heading line instead of swallowing its syntax. Contributed by Peter Gaultney.
  • Re-check a draft's passage when it is saved, since the note may have changed around it.

Full Changelog: https://github.com/No-Instructions/Relay-Comments/compare/0.5.2...0.6.0

README file from

Github

Relay Comments

Comments and suggested edits for Obsidian.

Relay Comments brings Google-Docs-style review to Obsidian. Comments and suggested edits are written into the Markdown file as CriticMarkup, and diff and sync with the note.

Comments

Collaborators' comments appear in your note as they write them.

Comments on lists, tasks, headings, quotes and callouts keep the block's Markdown syntax outside the highlight. A selection that runs into a later list, task, quote or heading line is refused, since the highlight would swallow that line's syntax. In Live Preview you can also select text inside a rendered callout and comment on it.

A comment arrives in a daily note, is read from the hover preview, and gets a reply

Suggestions

Accept or reject in place, or accept everything at once when the review is done.

Hovering a suggested replacement shows Accept and Reject; accepting rewrites the text in place

The sidebar

The sidebar lists the note's comments, suggestions, and highlights. Resolving a thread removes its markup from the note.

Opening the review sidebar and resolving a thread, which removes its card and its markup in the note

Identity

Relay Comments integrates with Relay and Obsidian Sync to provide user identity.

You can also add identities to the plugin's data.json. Each entry maps an ID to a name, a picture, and a color. This allows an agent to self-register its identity:

{
  "identities": [
    {
      "id": "mqvxlopr0ocsmgv",
      "name": "Shelly",
      "picture": "https://avatars.relay.md/?seed=as235jcgbe",
      "color": "#7c3aed"
    }
  ]
}

The data.json file is automatically reloaded on change.

Readers without a matching identity see the inline author field as the name.

Agents

The relay-comments skill teaches agents to use CriticMarkup as well as monitor notes for comments to respond inline.

Canvas

Place pins to add spatial feedback about the canvas layout. Comment on nodes or their contents.

A canvas card gets a comment from its right-click menu, then a freestanding pin lands between two cards

Privacy

Relay-comments does not make any network requests or have any client-side telemetry.

Format

Review state is CriticMarkup:

Mark Syntax
Addition {++inserted text++}
Deletion {--removed text--}
Replacement {~~old~>new~~}
Highlight {==marked text==}
Comment {>>comment text<<}

Comments also attach to Obsidian's native ==highlight== syntax.

The author is stored in the comment:

{==the passage==}{{authorId="j4n8b2x0q7m1zk5" author="Bongo Cat">>Can we ground this sooner?<<}}

Installation

Install Relay Comments from the Obsidian community plugin catalog.

Development

npm install
npm run check   # typecheck src/
npm run build   # typecheck + produce main.js

Unit tests live in tests/unit/; npm test runs them. See CONTRIBUTING.

License

MIT