markdown-review 0.0.4 → 0.0.6
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 +109 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,36 +1,126 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/rwoll/markdown-review/main/packages/vscode/images/logo.png" width="160" height="160" alt="Plan Review logo">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
[](https://github.com/rwoll/markdown-review/blob/main/LICENSE)
|
|
5
|
+
<h1 align="center">Markdown Review</h1>
|
|
5
6
|
|
|
6
|
-
>
|
|
7
|
-
> embedded questions, and export structured feedback
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>A markdown viewer with inline commenting for the AI era — read any <code>.md</code> file, annotate sections, answer AI-embedded questions, and export structured feedback.</strong>
|
|
9
|
+
</p>
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="vscode:extension/rwoll.markdown-review"><img src="https://img.shields.io/badge/VS%20Code-Install-0078d4?logo=visualstudiocode&logoColor=white" alt="Install in VS Code"></a>
|
|
13
|
+
<a href="vscode-insiders:extension/rwoll.markdown-review"><img src="https://img.shields.io/badge/VS%20Code%20Insiders-Install-24bfa5?logo=visualstudiocode&logoColor=white" alt="Install in VS Code Insiders"></a>
|
|
14
|
+
<a href="#copilot-cli-plugin"><img src="https://img.shields.io/badge/Copilot%20CLI%20Plugin-Available-24292f?logo=github" alt="Copilot CLI Plugin Available"></a>
|
|
15
|
+
<a href="https://www.npmjs.com/package/markdown-review"><img src="https://img.shields.io/npm/v/markdown-review" alt="npm version"></a>
|
|
16
|
+
</p>
|
|
12
17
|
|
|
13
|
-
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Demo
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Screenshot
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Why Markdown Review?
|
|
31
|
+
|
|
32
|
+
Markdown Review turns any `.md` file into a review surface — read it, annotate it, answer embedded questions, and send structured feedback back to an AI agent or your team:
|
|
33
|
+
|
|
34
|
+
- 🔍 **Read markdown as a document, not a chat message** — clean, readable layout with a live outline and notes panel.
|
|
35
|
+
- ❓ **Answer AI-embedded questions in context** — agents can drop `question:open`, `question:choice`, and `question:checkbox` blocks directly into the document.
|
|
36
|
+
- ✏️ **Annotate any section with one click** — leave comments on paragraphs, headings, code blocks, or list items.
|
|
37
|
+
- 🚀 **Send structured feedback in one click** — your answers and annotations flow back to the agent automatically, ready for it to act on.
|
|
38
|
+
|
|
39
|
+
Whether you're reviewing a `PLAN.md`, a `SPEC.md`, an `API.md`, or any other markdown file — Markdown Review gives you a commenting layer that works with AI agents out of the box. Point at a paragraph and say "change this" instead of manually quoting text in a chat thread.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## VS Code Extension
|
|
44
|
+
|
|
45
|
+
Install the extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=rwoll.markdown-review) to review any markdown file directly inside VS Code.
|
|
46
|
+
|
|
47
|
+
Once installed, open any `.md` file — Markdown Review opens automatically as the default editor for Markdown files. Read the document, answer any embedded questions, and click sections to annotate. Close the panel (or press the **Export** button) — structured feedback is sent to Copilot chat.
|
|
48
|
+
|
|
49
|
+
> **Tip:** To switch between the standard Markdown preview and Markdown Review, right-click a `.md` file in Explorer → **Open With…** and choose your preferred editor. Optionally choose **Set as Default** to persist that preference.
|
|
50
|
+
|
|
51
|
+
### Copilot Agent Skill
|
|
52
|
+
|
|
53
|
+
The extension ships with a built-in **Agent Skill** (`markdown-plan-review-feedback`) that Copilot and other AI agents can automatically discover and use. When the skill is active, the agent knows:
|
|
54
|
+
|
|
55
|
+
- The full Markdown Review workflow — generate a structured `.md` file, the user reviews it, feedback flows back to the agent.
|
|
56
|
+
- The `question:open`, `question:choice`, and `question:checkbox` block syntax for embedding interactive questions.
|
|
57
|
+
- Best practices for structuring a reviewable document (headings, question placement, annotatable blocks).
|
|
58
|
+
|
|
59
|
+
Simply ask Copilot to *"draft a plan for X"* or *"write a spec for Y"* and it will produce a question-rich Markdown file ready to open in Markdown Review — no manual prompt engineering required.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Copilot CLI Plugin
|
|
64
|
+
|
|
65
|
+
The Copilot CLI plugin adds a **review** skill to [GitHub Copilot in the terminal](https://docs.github.com/en/copilot/how-tos/copilot-cli). When invoked, Copilot writes a markdown file to disk, opens it in a browser-based review UI, and waits for your feedback — all without leaving the terminal.
|
|
66
|
+
|
|
67
|
+
### Install
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
copilot plugin install rwoll/markdown-review
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Or from within an interactive Copilot CLI session:
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
/plugin install rwoll/markdown-review
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### How It Works
|
|
80
|
+
|
|
81
|
+
1. Copilot writes a markdown file (e.g. `plan.md`, `spec.md`, or any `.md` file).
|
|
82
|
+
2. It runs `npx -y markdown-review@latest plan.md`, which starts a local server and opens your browser.
|
|
83
|
+
3. You review, annotate, and answer embedded questions in the browser UI.
|
|
84
|
+
4. You click **Submit** — feedback is sent back to Copilot and the server exits.
|
|
85
|
+
5. Copilot incorporates your feedback and continues.
|
|
86
|
+
|
|
87
|
+
### Manage
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
copilot plugin list # view installed plugins
|
|
91
|
+
copilot plugin update markdown-review # update to latest version
|
|
92
|
+
copilot plugin uninstall markdown-review # remove the plugin
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## CLI
|
|
98
|
+
|
|
99
|
+
`markdown-review` is a zero-install CLI that opens a local browser UI for reviewing any markdown file.
|
|
14
100
|
|
|
15
101
|
```bash
|
|
16
|
-
npx markdown-review
|
|
17
|
-
npx markdown-review
|
|
18
|
-
npx markdown-review PLAN.md --json
|
|
102
|
+
npx markdown-review README.md # review in browser, feedback to stdout
|
|
103
|
+
npx markdown-review SPEC.md -o fb.md # write feedback to file
|
|
104
|
+
npx markdown-review PLAN.md --json # JSON output instead of markdown
|
|
19
105
|
```
|
|
20
106
|
|
|
107
|
+
---
|
|
108
|
+
|
|
21
109
|
## Features
|
|
22
110
|
|
|
23
111
|
- **Document rendering** — headings, paragraphs, lists, blockquotes, syntax-highlighted code, and mermaid diagrams
|
|
24
|
-
- **Embedded AI questions** — open-text, single-choice, and multi-checkbox
|
|
112
|
+
- **Embedded AI questions** — open-text, single-choice, and multi-checkbox with "Other" option
|
|
25
113
|
- **Inline annotations** — click any block to leave a comment
|
|
26
114
|
- **General feedback** — start typing anywhere to open the comment sheet
|
|
27
|
-
- **Export** —
|
|
115
|
+
- **Export** — download `PLAN-feedback.md` with responses, annotations, and notes
|
|
116
|
+
- **Responsive** — mobile (< 800 px), tablet (800–1099 px), desktop (≥ 1100 px)
|
|
28
117
|
- **Dark theme** — high-contrast, reading-optimised
|
|
29
118
|
|
|
30
119
|
## Embedding Questions
|
|
31
120
|
|
|
32
|
-
|
|
33
|
-
|
|
121
|
+
Question blocks are authored in markdown by AI tools (for example Copilot or other agent workflows), and reviewers answer them directly in the UI.
|
|
122
|
+
|
|
123
|
+
Use fenced code blocks with a `question:` language tag:
|
|
34
124
|
|
|
35
125
|
````markdown
|
|
36
126
|
```question:open
|
|
@@ -51,37 +141,10 @@ options: Feature 1 | Feature 2 | Feature 3
|
|
|
51
141
|
```
|
|
52
142
|
````
|
|
53
143
|
|
|
54
|
-
##
|
|
144
|
+
## Contributing
|
|
55
145
|
|
|
56
|
-
|
|
57
|
-
install the **review** plugin and Copilot will automatically open plans for
|
|
58
|
-
review — no manual `npx` needed:
|
|
59
|
-
|
|
60
|
-
```bash
|
|
61
|
-
copilot plugin install rwoll/markdown-review:packages/copilot-plugin
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Once installed, Copilot writes a plan → opens the review UI in your browser →
|
|
65
|
-
waits for your feedback → incorporates it and continues. The whole loop happens
|
|
66
|
-
without leaving the terminal.
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
copilot plugin list # view installed plugins
|
|
70
|
-
copilot plugin update markdown-review # update to latest
|
|
71
|
-
copilot plugin uninstall markdown-review # remove
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
## 🧩 VS Code Extension
|
|
75
|
-
|
|
76
|
-
Prefer to stay in your editor? Install the
|
|
77
|
-
[Plan Review extension](https://marketplace.visualstudio.com/items?itemName=rwoll.markdown-review)
|
|
78
|
-
to review markdown plans directly inside VS Code — feedback is forwarded
|
|
79
|
-
straight to Copilot chat.
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
ext install rwoll.markdown-review
|
|
83
|
-
```
|
|
146
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, testing, and PR guidelines.
|
|
84
147
|
|
|
85
148
|
## License
|
|
86
149
|
|
|
87
|
-
[MIT](
|
|
150
|
+
[MIT](LICENSE)
|
package/package.json
CHANGED