Ruletypescript
Markdown Rule
- `*.md` - English version (default) - `*.ja.md` - Japanese version
Markdown File Synchronization Rules
Naming Convention
*.md- English version (default)*.ja.md- Japanese version
Cross-Language Links
Each markdown file must include a link to its counterpart at the top:
- English version (
*.md): Add> ๐ฏ๐ต [ๆฅๆฌ่ช็](./filename.ja.md)at the top - Japanese version (
*.ja.md): Add> ๐บ๐ธ [English](./filename.md)at the top
Synchronization Requirements
When creating or modifying markdown files, ensure both language versions are kept in sync:
- Creating a new file: If you create
example.md, also createexample.ja.mdwith Japanese translation - Modifying content: When updating
example.md, also updateexample.ja.mdto reflect the same changes - Structural consistency: Both versions must have the same structure (headings, sections, lists)
- Cross-language links: Both versions must have links to each other at the top
Diagrams
When creating diagrams, prefer Mermaid over ASCII art / box-drawing characters:
-
Prefer Mermaid: Use Mermaid syntax for flowcharts, sequence diagrams, class diagrams, etc.
- Renders consistently across platforms
- No alignment issues with different character widths
- Easier to maintain and modify
-
When to use ASCII art: Only use box-drawing characters when Mermaid cannot express the diagram (e.g., file tree structures)
- Keep text labels in English to maintain alignment
- Add a separate explanation table below for translations
Mermaid example:
flowchart TD
A[Application Code] --> B[AppContext]
B --> C[Runtime Interface]
C --> D[Deno Runtime]
C --> E[Node.js Runtime]
Translation Guidelines
- Translate content naturally, not word-for-word
- Keep code blocks, file paths, and technical terms unchanged
- Dates: English uses
YYYY-MM-DD, Japanese usesYYYYๅนดMๆDๆฅ - Diagrams: Keep Mermaid diagrams identical in both versions (node labels can be translated if needed). For ASCII art diagrams, keep text in English and provide translations in a separate table below
Exceptions
The following files are excluded from this rule:
- Files in
node_modules/ - Auto-generated files
- Configuration files (e.g.,
.claude/directory)