Persian RTL Markdown Preview

Correct Persian/Farsi RTL and mixed English–Persian text in VS Code's built-in Markdown Preview.

فارسی

این افزونه جهت نوشتار و چیدمان پیش‌نمایش داخلی پرونده‌های متنی را برای زبان فارسی اصلاح می‌کند. تیترها، بندها، فهرست‌ها، نقل‌قول‌ها و خانه‌های جدول به‌درستی راست‌به‌چپ می‌شوند.

متن‌های کاملاً انگلیسی و قطعه‌های کد چپ‌به‌راست باقی می‌مانند. اگر یک بند شامل هر دو زبان باشد، وجود نویسه‌های فارسی باعث می‌شود جهت پایهٔ همان بند راست‌به‌چپ انتخاب شود.

قلم فارسی همراه افزونه است و بدون نصب جداگانه یا اتصال اینترنت بارگذاری می‌شود. این افزونه فقط پیش‌نمایش را تغییر می‌دهد و محتوای پروندهٔ اصلی دست‌نخورده باقی می‌ماند.

English

This extension fixes text direction and layout in VS Code's built-in Markdown Preview. Persian blocks are rendered right-to-left, while English-only text and code remain left-to-right.

Mixed-language blocks are detected per block, including paragraphs, headings, lists, blockquotes, and table cells. The bundled Noto Sans Arabic font provides consistent offline rendering without requiring a separate font installation.

The extension changes only the rendered preview. Your Markdown source remains untouched.

Preview

Light	Dark

Features

• Per-block RTL/LTR detection for paragraphs, headings, lists, blockquotes and table cells.
• Correct RTL layout when a mixed sentence begins with English text.
• LTR isolation for inline code and fenced code blocks.
• Theme-aware colors for light, dark and high-contrast themes.
• Bundles Noto Sans Arabic for consistent offline rendering; no system font installation required.
• Uses VS Code's official Markdown extension API; no core patching.
• No settings, telemetry, runtime dependencies or network requests.
• Works in Restricted Mode.

Install

From a VSIX file

1. Download the .vsix file from the latest GitHub release.
2. In VS Code, open Extensions.
3. Open the … menu and select Install from VSIX….
4. Reload the VS Code window when prompted.

Use

Open any .md file and run Markdown: Open Preview. The shortcut is ⌘⇧V on macOS and Ctrl+Shift+V on Windows/Linux.

This extension changes the rendered preview only. The plain-text Markdown editor remains unchanged.

How it works

The extension inspects each rendered Markdown block. A block containing Persian or Arabic-script characters receives an explicit RTL direction; English-only blocks remain LTR. Code is always isolated as LTR. Styling is added through VS Code's supported markdown.previewStyles and Markdown-it extension points.

Development

npm install
npm test
npm run package

The package command creates a distributable .vsix file.

Contributing

Bug reports and pull requests are welcome. Please read CONTRIBUTING.md before contributing. For security issues, follow SECURITY.md.

License

The extension code is MIT licensed © Sina Tabar. The bundled Noto Sans Arabic font is distributed under the SIL Open Font License 1.1.