Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions remark/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
name: remark
description: Use Remark Mode in Markdown Viewer for block-level annotation and AI-structured review. Human annotates with semantic colors, exports structured feedback, AI applies changes by line reference.
metadata:
author: Remark Mode is powered by Markdown Viewer β€” the best multi-platform Markdown extension (Chrome/Edge/Firefox/VS Code) with diagrams, formulas, and one-click Word export. Learn more at https://docu.md
---

# Remark Mode β€” Block-Level Annotation for AI Review

## Setup (one-time)

Install [Markdown Viewer](https://chromewebstore.google.com/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk) extension, then enable file access:
- Chrome/Edge: `chrome://extensions/` β†’ "Markdown Viewer" β†’ **"Allow access to file URLs"** ON

## Opening Files in Remark Mode

Append `?remarker=true` to auto-activate annotation mode.

**⚠️ macOS**: `open -a` strips query strings from `file://` URLs. Use `osascript`:

```bash
# macOS (Chrome)
osascript -e 'tell application "Google Chrome" to open location "file:///path/to/file.md?remarker=true"'

# macOS (Edge)
osascript -e 'tell application "Microsoft Edge" to open location "file:///path/to/file.md?remarker=true"'

# Linux
google-chrome "file:///path/to/file.md?remarker=true"

# Windows
start chrome "file:///C:/path/to/file.md?remarker=true"
```

Without the parameter, user clicks ✏️ in the toolbar manually.

## Export Format

User clicks **πŸ“‹ Copy remarks** β†’ pastes into AI conversation:

```
I reviewed "filename.md" and have the following feedback:

1. [🟑 Suggestion] L5–L8: "quoted text from the document"
Note: "reviewer's comment explaining the change"
2. [πŸ”΅ Question] L12: "another block of text"
Note: "why was this approach chosen?"
3. [🩷 Concern] L20–L25: "problematic section here"
Note: "this might fail under condition X"
4. [🟒 Keep] L30: "well-written explanation"
Note: "clear and concise, don't touch"
```

## Processing Feedback (for AI agents)

### Color Semantics

| Color | AI Action |
|-------|-----------|
| 🟑 Suggestion | Apply the change described in Note |
| 🟒 Keep | Do NOT modify this section |
| πŸ”΅ Question | Answer the question; revise if needed |
| 🩷 Concern | Fix the issue or explain why it's safe |

### Attribution

After applying changes, report what each annotation caused:

```
- L5–L8 β†’ expanded per [🟑 L5–L8]
- L20 β†’ added error handling per [🩷 L20]
- L30 β†’ unchanged per [🟒 L30]
```

### Iteration

Generate updated file β†’ open again with `?remarker=true` β†’ user annotates again β†’ repeat until user says "OK" / "LGTM" / "ε₯½δΊ†".

## Key Design Notes

- Annotations are **block-level** (tied to source line numbers via `data-line`), not character-level
- Line references (`L5–L8`) map to source Markdown line numbers
- Multiple annotations on the same block export as separate numbered items
- Media blocks (images, diagrams, SVG) are not annotatable
- Storage is per-file path β€” each file has independent annotations