Releases: oubakiou/mdxg-redline
Releases · oubakiou/mdxg-redline
v0.1.5
What's New
ドキュメントと発見性(discoverability)向上が中心のリリースで、CLI / ビューアの機能に変更はありません。
- README 冒頭を体験導線化: MDXG ジャーゴン先頭をやめ、価値提案+具体動作(範囲選択してインラインコメント)を主語にしたタグラインに差し替え。デモ動画直後に online 先頭の圧縮版 Quick start(Try now / Local review / Agent loop / Privacy)を追加し、MDXG 準拠表は下方へ移動。Privacy は outbound/inbound の非対称を正確に記述(standalone / CLI は完全ローカル、online は本文・コメントの外部送信なし)。ja / en 両 README をミラー
- スマートフォン版のデモ動画を PC 版と並べて追加(モバイルでもレビューできる点を訴求)
- npm
keywordsを補強して発見性を改善(redline/document-review/llm-agent/markdown-annotationを追加) md-reviewskill のdescriptionを英語化し、レジストリ検索流入とエージェントのトリガ判定精度を強化(markdown review/human-in-the-loop/structured JSON feedback/inline comments/redlineを網羅)- 本 release から
md-reviewskill を install / pin できる(gh skill install oubakiou/mdxg-redline md-review --pin v0.1.5)
Full Changelog: v0.1.4...v0.1.5
v0.1.4
What's New
オンライン版 (mkdn.review) を追加
- ブラウザで
https://mkdn.review/を開き、?url=で渡した markdown を URL fetch して読めるオンライン版を新設(Cloudflare Pages 配信)。github.com / raw.githubusercontent.com / gist の表示用 URL もそのまま受け付け、effective allowlist と書き換え対象 host を Open URL modal に表示する - shiki grammar / Mermaid runtime / KaTeX runtime を dynamic import 化し、必要時のみ後追い fetch する構成に変更(3 ファイル独立 retry / 永続 listener / Cache-Control)
- online deep-link (
#p:/#l:) の後追い描画シフトを補正する再スクロール機構を追加 - online 版に固定 OGP / Twitter Card、inline SVG favicon / apple-touch-icon / 404.html を追加
UI 国際化 (i18n)
- UI 文言を EN / JA で切り替え可能に。設定モーダルに theme / lang 切替を集約し focus trap を追加
- CLI に
--lang <auto|en|ja>を追加(help / エラーメッセージの出力言語。生成 HTML の表示言語には非干渉)
スマートフォン対応
@media (max-width:768px)の drawer レイアウトを実装し、TOC/Comment/Searchをフッターから操作できるように- 画面左下に 1 画面送り FAB を追加(タップ=下 / 上下フリック=方向送り)、出現時の指追従矢印でフリック発見性を提示
- タッチでの範囲選択時に +Comment フローターを表示。Mermaid 拡大モーダルの pinch ズーム対応、タッチ端末で消えないツールチップ等を修正
その他
- ツールバーを
Open ▾メニューに統合しPaste markdown…modal を追加 - ヘッダ app-brand / favicon に Redline 比喩の白下線 icon を追加
- ページ切替で
#doc全再 mount を回避し軽量 refresh に変更(パフォーマンス改善) - shiki 4.2.0 に追従、ツールバー 3 アイコンを GitHub Octicons SVG に統一
Full Changelog: v0.1.3...v0.1.4
v0.1.3
What's New
- review HTML 生成時、配置先ディレクトリに対応する
<name>-<hash>-feedback.jsonがあれば自動で読み込み、前ラウンドのレビューコメントを引き継いで続きから再開できる resume 経路を追加(v0.1.2 から含まれる) feedback.jsonのcomments[]にblockId/startOffset/endOffsetも併記するようになった(resume 経路でisImportableCommentの必須フィールドを満たすため。後段 LLM パイプラインは無視してよい)sanitizeMdFileNameをsrc/coreに移動し、CLI 生成 HTML 名と browser 書き出し名の命名規約 §8 を共通実装で揃えた(--document-name 'a/b.md'等の入力で CLI と browser のファイル名がブレるバグを構造的に解消)- stdin 入力時は cwd 偶発一致を避けるため skip、docHash 不一致 / 非 ENOENT I/O エラー時は stderr 警告 + skip にとどめて CLI 全体を落とさない
gh skill publishでmd-reviewskill を本 release から install / pin できるようになった(gh skill install oubakiou/mdxg-redline md-review --pin v0.1.3)
Full Changelog: v0.1.2...v0.1.3
v0.1.2
What's New
- review HTML 生成時、配置先ディレクトリに対応する
<name>-<hash>-feedback.jsonがあれば自動で読み込み、前ラウンドのレビューコメントを引き継いで続きから再開できる resume 経路を追加 feedback.jsonのcomments[]にblockId/startOffset/endOffsetも併記するようになった(resume 経路でisImportableCommentの必須フィールドを満たすため。後段 LLM パイプラインは無視してよい)sanitizeMdFileNameをsrc/coreに移動し、CLI 生成 HTML 名と browser 書き出し名の命名規約 §8 を共通実装で揃えた(--document-name 'a/b.md'等の入力で CLI と browser のファイル名がブレるバグを構造的に解消)- stdin 入力時は cwd 偶発一致を避けるため skip、docHash 不一致 / 非 ENOENT I/O エラー時は stderr 警告 + skip にとどめて CLI 全体を落とさない
Full Changelog: v0.1.1...v0.1.2
v0.1.1
Full Changelog: v0.1.0...v0.1.1
v0.1.0
mdxg-redline v0.1.0 — 初版リリース
MDXG に準拠した markdown レビューツールの初版。LLM エージェントが人間レビュワーから「長文 markdown に対するフィードバック」を散文の感想ではなく位置情報付きの構造化 JSON として受け取るためのブラウザツールです。
利用方法
A. standalone.html を直接配布
このリリースの standalone.html をダウンロードしてブラウザで開く。インストール・サーバー不要・LLM コンテンツ起点での外部通信ゼロ。
B. npm 経由で CLI を起動
npx mdxg-redline <input.md>入力 markdown と同じディレクトリに <basename>-<docHash>-review.html が生成され、標準ブラウザが自動起動します。
主要機能
- 位置情報付きインラインコメント (
headingPath/sourceLine) を構造化 JSON で書き出し - Shiki bundled 全言語 (約 235) のシンタックスハイライト
- Mermaid ダイアグラム描画 / KaTeX 数式描画
- Virtual Pages による Word / Pages 風の縦スクロール通読
- WASD ベースのキーボードナビゲーション (左手のみで pane 移動・scroll・activate・検索)
- マークダウンプレビューの CSS 差し替え (
--markdown-css <path>、テンプレは添付のmarkdown.sample.css)
MDXG 準拠状況
MDXG Viewer (読み取り専用レンダラ準拠レベル) の MUST 11 セクション + SHOULD 3 セクション (Math / Diagram / Footnotes) を実装済み。詳細は README 参照。
動作要件
- standalone.html: 任意のモダンブラウザ (Chromium 系で
Write feedback.jsonのフルサポート) - CLI: Node.js 24+