From 451d59c1a75feba6f67787772b43d7cbad1c99dc Mon Sep 17 00:00:00 2001 From: mssh21 Date: Fri, 16 Oct 2026 13:03:15 +0900 Subject: [PATCH 1/3] Allow the Yarn 4 package-manager check to write its lockfile on CI The Release workflow failed before npm publish because Yarn 4 makes installs immutable when it detects CI, and the copied example starts with an empty yarn.lock, so its first install was refused with YN0028. Co-Authored-By: Claude Opus 5.5 --- scripts/verify-package-managers.mjs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/verify-package-managers.mjs b/scripts/verify-package-managers.mjs index 68389f7..3b23229 100644 --- a/scripts/verify-package-managers.mjs +++ b/scripts/verify-package-managers.mjs @@ -20,6 +20,9 @@ const runners = { }; // Yarn 4 quarantines recently published versions, which would block checking a release right after publishing it. process.env.YARN_NPM_MINIMAL_AGE_GATE ??= '0'; +// Yarn 4 makes installs immutable whenever it detects CI, and the copied example has no lockfile yet, so the first install would be refused as a lockfile change. +// Yarn 4はCIを検出するとインストールを変更不可にし、コピーした例にはまだロックファイルがないため、最初のインストールがロックファイルの変更として拒否される。 +process.env.YARN_ENABLE_IMMUTABLE_INSTALLS ??= 'false'; const selected = (args.only ?? Object.keys(runners).join(',')).split(','); function run(command, options = {}) { From 4559af3a93b83fddba665ac8da4035709690db0f Mon Sep 17 00:00:00 2001 From: mssh21 Date: Fri, 16 Oct 2026 13:04:12 +0900 Subject: [PATCH 2/3] Focus the READMEs on using the package and give the site the logo favicon The READMEs drop the "Try locally" demo steps, which are for contributors and already in CONTRIBUTING.md, and link the website, documentation and npm page right after the introduction. The GitHub Pages site uses the NeedMark logo from the toolbar as its favicon, blue in light mode and white in dark mode. Co-Authored-By: Claude Opus 5.5 --- README.ja.md | 12 ++---------- README.md | 12 ++---------- site/favicon.svg | 1 + site/index.html | 2 +- site/ja/index.html | 2 +- 5 files changed, 7 insertions(+), 22 deletions(-) create mode 100644 site/favicon.svg diff --git a/README.ja.md b/README.ja.md index 2b4cf76..0606707 100644 --- a/README.ja.md +++ b/README.ja.md @@ -6,15 +6,7 @@ UIを指してコメントを書き、いつものコーディングAIへ渡す MITライセンス。アカウント、MCPサーバー、特定のAIプロバイダーは必須ではありません。操作UIはReactに依存せず、Vite開発用プラグイン、またはNext.jsなどの既存HTTP開発サーバー向けレビュー用プロキシで使えます。ホスト型サービスNeedBackから独立したパッケージです。 -## ローカルで試す - -```sh -pnpm install -pnpm build -pnpm demo -``` - -`http://127.0.0.1:4190`を開き、ツールバーから対象を選んでコメントを書きます。設定で日本語・英語と、DOM・タブ・画像なしの撮影方法を選べます。デモのコメントは`demo/.needmark/feedback`に保存されます。 +[Webサイト](https://mssh21.github.io/needmark/ja/) · [ドキュメント](docs/README.md) · [npm](https://www.npmjs.com/package/needmark) ## 自分のプロジェクトに導入する @@ -67,4 +59,4 @@ DOM撮影は共有許可なしで使えますが、再現できる描画に制 - [Getting started](docs/getting-started.md): 同じ内容の英語ガイド。 - [アーキテクチャと動作上の制約（英語）](docs/architecture.md): 実装の詳細なリファレンス。 - [Agentationとの比較とプロダクト評価](docs/agentation-comparison.ja.md) -- [ドキュメント一覧](docs/README.md) · [MITライセンス](LICENSE) +- [ドキュメント一覧](docs/README.md) · [コントリビューション（英語）](CONTRIBUTING.md) · [MITライセンス](LICENSE) diff --git a/README.md b/README.md index 94994cd..877db75 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,7 @@ Point at your UI, leave a comment, and hand it to your usual coding agent. NeedM MIT licensed. It requires no account, MCP server or specific AI provider. The runtime UI does not require React; use the Vite development plugin or a separate review proxy for an existing HTTP development server, including Next.js. NeedMark is independent of hosted NeedBack. -## Try locally - -```sh -pnpm install -pnpm build -pnpm demo -``` - -Open `http://127.0.0.1:4190`. Use the toolbar to select a target and write a comment. Settings let you choose English or Japanese and DOM, tab or image-free capture. Demo feedback stays in `demo/.needmark/feedback`. +[Website](https://mssh21.github.io/needmark/) · [Documentation](docs/README.md) · [npm](https://www.npmjs.com/package/needmark) ## Install in your project @@ -67,4 +59,4 @@ Set `language: 'en'` or `'ja'` in `needmark.config.ts`; the UI defaults to Japan - [はじめに](docs/getting-started.ja.md): the same guide in Japanese. - [Architecture and operating limits](docs/architecture.md): detailed implementation reference in English. - [Agentation comparison and product evaluation (Japanese)](docs/agentation-comparison.ja.md) -- [Documentation index](docs/README.md) · [MIT license](LICENSE) +- [Documentation index](docs/README.md) · [Contributing](CONTRIBUTING.md) · [MIT license](LICENSE) diff --git a/site/favicon.svg b/site/favicon.svg new file mode 100644 index 0000000..def4e21 --- /dev/null +++ b/site/favicon.svg @@ -0,0 +1 @@ + diff --git a/site/index.html b/site/index.html index 0a10f52..52cd4b0 100644 --- a/site/index.html +++ b/site/index.html @@ -7,7 +7,7 @@ - +
diff --git a/site/ja/index.html b/site/ja/index.html index 9d3ae1e..ebbdff6 100644 --- a/site/ja/index.html +++ b/site/ja/index.html @@ -7,7 +7,7 @@ - +
From 3b4d5420dd2e159c8aee3549d6daf4e8ae266ce1 Mon Sep 17 00:00:00 2001 From: mssh21 Date: Fri, 16 Oct 2026 13:18:58 +0900 Subject: [PATCH 3/3] Show the NeedMark wordmark logo in the site header The header's text wordmark becomes the designed logo, with the light or dark variant chosen by the reader's colour scheme on both language pages. Co-Authored-By: Claude Opus 5.5 --- site/index.html | 2 +- site/ja/index.html | 2 +- site/logo-dark.svg | 23 +++++++++++++++++++++++ site/logo-light.svg | 23 +++++++++++++++++++++++ site/style.css | 3 ++- 5 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 site/logo-dark.svg create mode 100644 site/logo-light.svg diff --git a/site/index.html b/site/index.html index 52cd4b0..68dcc78 100644 --- a/site/index.html +++ b/site/index.html @@ -11,7 +11,7 @@
- NeedMark + NeedMark