Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

## 自分のプロジェクトに導入する

Expand Down Expand Up @@ -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)
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
3 changes: 3 additions & 0 deletions scripts/verify-package-managers.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {}) {
Expand Down
1 change: 1 addition & 0 deletions site/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
<meta name="description" content="Point at your UI, leave a comment, and hand it to any coding agent. Local-first visual feedback with context and screenshots.">
<link rel="alternate" hreflang="ja" href="ja/">
<link rel="stylesheet" href="style.css">
<link rel="icon" href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Cpath d='M16 3a11 11 0 0 0-11 11v15l11-4a11 11 0 0 0 0-22z' fill='%231965e3'/%3E%3C/svg%3E">
<link rel="icon" href="favicon.svg" type="image/svg+xml">
</head>
<body>
<header class="top">
<a class="wordmark" href="./">NeedMark</a>
<a class="wordmark" href="./"><picture><source srcset="logo-dark.svg" media="(prefers-color-scheme: dark)"><img src="logo-light.svg" alt="NeedMark" width="122" height="20"></picture></a>
<nav>
<a class="optional" href="https://github.com/mssh21/needmark/blob/main/docs/getting-started.md">Docs</a>
<a class="optional" href="https://www.npmjs.com/package/needmark">npm</a>
Expand Down
4 changes: 2 additions & 2 deletions site/ja/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
<meta name="description" content="UIを指してコメントを書き、いつものコーディングAIへ渡す。コメントと対象の情報、スクリーンショットをローカルファイルに保存します。">
<link rel="alternate" hreflang="en" href="../">
<link rel="stylesheet" href="../style.css">
<link rel="icon" href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Cpath d='M16 3a11 11 0 0 0-11 11v15l11-4a11 11 0 0 0 0-22z' fill='%231965e3'/%3E%3C/svg%3E">
<link rel="icon" href="../favicon.svg" type="image/svg+xml">
</head>
<body>
<header class="top">
<a class="wordmark" href="./">NeedMark</a>
<a class="wordmark" href="./"><picture><source srcset="../logo-dark.svg" media="(prefers-color-scheme: dark)"><img src="../logo-light.svg" alt="NeedMark" width="122" height="20"></picture></a>
<nav>
<a class="optional" href="https://github.com/mssh21/needmark/blob/main/docs/getting-started.ja.md">ドキュメント</a>
<a class="optional" href="https://www.npmjs.com/package/needmark">npm</a>
Expand Down
23 changes: 23 additions & 0 deletions site/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading