markdown-review 0.0.1 → 0.0.4
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 +87 -0
- package/bin/markdown-review.js +1 -1
- package/package.json +5 -3
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# markdown-review
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/markdown-review)
|
|
4
|
+
[](https://github.com/rwoll/markdown-review/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
> Interactive markdown plan review UI — annotate sections, answer AI-agent
|
|
7
|
+
> embedded questions, and export structured feedback.
|
|
8
|
+
|
|
9
|
+
`markdown-review` is a zero-install CLI that opens a local browser UI for
|
|
10
|
+
reviewing markdown plans. It is part of the
|
|
11
|
+
[markdown-review](https://github.com/rwoll/markdown-review) monorepo.
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx markdown-review PLAN.md # review in browser, feedback to stdout
|
|
17
|
+
npx markdown-review PLAN.md -o fb.md # write feedback to file
|
|
18
|
+
npx markdown-review PLAN.md --json # JSON output instead of markdown
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
- **Document rendering** — headings, paragraphs, lists, blockquotes, syntax-highlighted code, and mermaid diagrams
|
|
24
|
+
- **Embedded AI questions** — open-text, single-choice, and multi-checkbox
|
|
25
|
+
- **Inline annotations** — click any block to leave a comment
|
|
26
|
+
- **General feedback** — start typing anywhere to open the comment sheet
|
|
27
|
+
- **Export** — structured feedback as markdown or JSON
|
|
28
|
+
- **Dark theme** — high-contrast, reading-optimised
|
|
29
|
+
|
|
30
|
+
## Embedding Questions
|
|
31
|
+
|
|
32
|
+
Use fenced code blocks with a `question:` language tag so reviewers can answer
|
|
33
|
+
directly in the UI:
|
|
34
|
+
|
|
35
|
+
````markdown
|
|
36
|
+
```question:open
|
|
37
|
+
id: q-approach
|
|
38
|
+
question: What do you think about this approach?
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
```question:choice
|
|
42
|
+
id: q-preference
|
|
43
|
+
question: Which option do you prefer?
|
|
44
|
+
options: Option A | Option B | Option C
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```question:checkbox
|
|
48
|
+
id: q-features
|
|
49
|
+
question: Select all that apply
|
|
50
|
+
options: Feature 1 | Feature 2 | Feature 3
|
|
51
|
+
```
|
|
52
|
+
````
|
|
53
|
+
|
|
54
|
+
## 🚀 Using GitHub Copilot CLI? Install the Plugin!
|
|
55
|
+
|
|
56
|
+
If you use [GitHub Copilot in the terminal](https://docs.github.com/en/copilot/how-tos/copilot-cli),
|
|
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
|
+
```
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
[MIT](https://github.com/rwoll/markdown-review/blob/main/LICENSE)
|