md-annotator-opencode 0.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -0
- package/annotator.html +2991 -0
- package/commands/annotate:md.md +34 -0
- package/dist/index.js +28654 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# md-annotator-opencode
|
|
2
|
+
|
|
3
|
+
OpenCode plugin for interactive markdown annotation.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add to your `opencode.json`:
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"plugins": ["md-annotator-opencode"]
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
### Tool
|
|
18
|
+
|
|
19
|
+
The agent can call `annotate_markdown` with a file path:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
annotate_markdown({ filePath: "/path/to/file.md" })
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Command
|
|
26
|
+
|
|
27
|
+
Use `/annotate:md <file>` in the chat to trigger annotation.
|
|
28
|
+
|
|
29
|
+
## What Users Can Do
|
|
30
|
+
|
|
31
|
+
- **Select text** to highlight portions of the document
|
|
32
|
+
- **Mark for deletion** - indicate text that should be removed
|
|
33
|
+
- **Add comments** - provide feedback on specific sections
|
|
34
|
+
- **Approve** - confirm the document needs no changes
|
|
35
|
+
|
|
36
|
+
## Environment Variables
|
|
37
|
+
| Variable | Description |
|
|
38
|
+
|----------|-------------|
|
|
39
|
+
| `MD_ANNOTATOR_PORT` | Override the server port (default: 3000) |
|
|
40
|
+
| `MD_ANNOTATOR_BROWSER` | Custom browser application |
|
|
41
|
+
|
|
42
|
+
## Output
|
|
43
|
+
|
|
44
|
+
The tool returns either:
|
|
45
|
+
- `APPROVED: No changes requested.` - User approved the file
|
|
46
|
+
- Structured markdown feedback with annotations for the agent to apply
|