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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ This template is designed for junior engineers to learn plugin development with
- **TypeScript**: Full type safety
- **Tailwind CSS 4**: Modern styling

> **⚠️ Important: No Arbitrary Values**
>
> Do NOT use Tailwind's arbitrary values (e.g., `bg-[#1a1a2e]`, `w-[137px]`) in plugin code.
> MulmoChat uses `@source` directive to scan plugins, which only supports standard Tailwind classes.
> Use standard classes like `bg-slate-900` instead.

## Quick Start

```bash
Expand Down
28 changes: 28 additions & 0 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,20 @@ export default { plugin };

## Important Notes

### ⚠️ No Tailwind Arbitrary Values

Do NOT use Tailwind's arbitrary values (JIT syntax) in plugin code:

```html
<!-- ✅ Good: Standard Tailwind classes -->
<div class="bg-slate-900 w-48 p-4">

<!-- ❌ Bad: Arbitrary values - will NOT work in MulmoChat -->
<div class="bg-[#1a1a2e] w-[137px] p-[10px]">
```

MulmoChat uses Tailwind's `@source` directive to scan plugin dist files. This only works with standard Tailwind classes. If you need custom values, define them in your plugin's `style.css` or use inline styles.

### ⚠️ View.vue Reactivity

```typescript
Expand Down Expand Up @@ -623,6 +637,20 @@ yarn dev

## 重要な注意点

### ⚠️ Tailwind Arbitrary Values 禁止

プラグインコードでは Tailwind の arbitrary values(JIT構文)を使用しないでください:

```html
<!-- ✅ 良い例: 標準 Tailwind クラス -->
<div class="bg-slate-900 w-48 p-4">

<!-- ❌ 悪い例: Arbitrary values - MulmoChat で動作しません -->
<div class="bg-[#1a1a2e] w-[137px] p-[10px]">
```

MulmoChat は Tailwind の `@source` ディレクティブを使用してプラグインの dist ファイルをスキャンします。これは標準の Tailwind クラスのみをサポートします。カスタム値が必要な場合は、プラグインの `style.css` で定義するか、インラインスタイルを使用してください。

### ⚠️ View.vue のリアクティビティ

```typescript
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,7 @@ ESLintがコードの問題点を指摘します。表示されたエラーや
1. **インタラクティブ性を追加**: `sendTextMessage`を使ってチャットにメッセージを送る
2. **状態を追加**: `viewState`を使ってUI状態を永続化
3. **スタイルを整える**: Tailwind CSSで美しいデザイン
> ⚠️ **重要**: `bg-[#1a1a2e]` のような arbitrary values は使用しないでください。MulmoChat は `@source` を使ってプラグインをスキャンするため、標準の Tailwind クラスのみサポートされます。
4. **公開**: [npm公開ガイド](./npm-publishing-guide.md)に従う

詳細は[高度な機能ガイド](./advanced-features.ja.md)を参照してください。
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -990,6 +990,7 @@ ESLint will point out code problems. Fix any errors or warnings shown.
1. **Add Interactivity**: Use `sendTextMessage` to send messages back to chat
2. **Add State**: Use `viewState` to persist UI state
3. **Style It**: Use Tailwind CSS for beautiful designs
> ⚠️ **Important**: Do NOT use arbitrary values like `bg-[#1a1a2e]`. MulmoChat uses `@source` to scan plugins, which only supports standard Tailwind classes.
4. **Publish**: Follow [npm Publishing Guide](./npm-publishing-guide.md)

See [Advanced Features Guide](./advanced-features.md) for details on these topics.
Expand Down
18 changes: 18 additions & 0 deletions docs/plugin-development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,24 @@ npm run build

---

## Important Notes

### ⚠️ No Tailwind Arbitrary Values

Do NOT use Tailwind's arbitrary values (JIT syntax) in plugin code:

```html
<!-- ✅ Good: Standard Tailwind classes -->
<div class="bg-slate-900 w-48 p-4">

<!-- ❌ Bad: Arbitrary values - will NOT work in MulmoChat -->
<div class="bg-[#1a1a2e] w-[137px] p-[10px]">
```

MulmoChat uses Tailwind's `@source` directive to scan plugin dist files. This only works with standard Tailwind classes. If you need custom values, define them in your plugin's `style.css` or use inline styles.

---

## Checklist

### Required Files
Expand Down