| d2(1) | General Commands Manual | d2(1) |
نام (NAME)
d2 —
کامپایل
و رندر
دیاگرامهای
d2 به svg
خلاصه دستور (SYNOPSIS)
d2 [--watch
false] [--theme
0]
[--salt string]
file.d2 [file.svg |
file.png | file.pdf |
file.pptx | file.gif |
file.txt] d2
layout [name]
d2 fmt file.d2
... d2 play
file.d2 d2
validate file.d2
توضیحات (DESCRIPTION)
دستور
d2 فایل
file.d2 را به
file.svg | file.png |
file.pdf | file.pptx |
file.gif | file.txt
کامپایل و
رندر
میکند.
اگر مسیر خروجی داده نشود، پیشفرض file.svg است.
برای خواندن از stdin یا نوشتن در stdout، مقدار - را ارسال کنید.
هرگز از
وجود فایل
خروجی برای
بررسی
موفقیت
استفاده
نکنید.
همیشه از
وضعیت خروج
d2
استفاده
کنید. دلیل
این امر این
است که گاهی
اوقات
هنگام بروز
خطا در زمان
رندر، d2
همچنان
خروجی رندر
جزئی را
مینویسد
تا امکان
اصلاح و
تکرار روی
دیاگرام
خراب فراهم
شود.
مستندات بیشتر، کد منبع و مجوز را در https://github.com/d2lang/d2 ببینید.
آیکونهای میزبانیشده در https://icons.d2lang.com
محیط اجرای آنلاین (Playground) در https://play.d2lang.com
گزینهها (OPTIONS)
-w,--watchfalse- پایش
تغییرات
فایل ورودی
و بارگذاری
مجدد زنده.
از
$PORTو$HOSTبرای تعیین آدرس گوش دادن استفاده کنید. -h,--hostlocalhost- آدرس گوش دادن میزبان در هنگام استفاده به همراه watch.
-p,--port0- پورت گوش دادن در هنگام استفاده به همراه watch.
-t,--theme0- تنظیم شناسه پوسته (تم) دیاگرام.
--dark-theme-1- پوستهای
که در صورت
فعال بودن
حالت تاریک
در مرورگر
بیننده
استفاده
میشود. اگر
تنظیم
نشود،
--themeهم برای حالت روشن و هم تاریک استفاده خواهد شد. توجه داشته باشید که استایلهای صریح تنظیمشده در کد D2 همچنان اعمال میشوند و ممکن است نتایج غیرمنتظرهای ایجاد کنند. ما قصد داریم این مشکل را با اختصاصیسازی نقشههای استایل در حالت روشن/تاریک D2 حل کنیم. ببینید: https://github.com/d2lang/d2/issues/831. -s,--sketchfalse- رندر کردن دیاگرام به شکلی که انگار با دست طراحی شده است.
--centerflag- قرار دادن SVG در مرکز کادر نمایش ظرف (viewbox)، مانند صفحه مرورگر شما.
--scale-1- مقیاسبندی خروجی. برای نمونه، 0.5 برای نصف کردن اندازه پیشفرض. مقدار پیشفرض -1 به این معنی است که SVGها با صفحه تطبیق داده میشوند و سایر فرمتها از اندازه پیشفرض رندر خود استفاده خواهند کرد. تنظیم روی 1 تطبیق SVG با اندازه صفحه را خاموش میکند.
--font-regular- مسیر فایل .ttf برای قلم عادی (regular). در صورت عدم ارائه، از Source Sans Pro Regular استفاده میشود.
--font-italic- مسیر فایل .ttf برای قلم مورب (italic). در صورت عدم ارائه، از Source Sans Pro Regular-Italic استفاده میشود.
--font-bold- مسیر فایل .ttf برای قلم توپر (bold). در صورت عدم ارائه، از Source Sans Pro Bold استفاده میشود.
--font-semibold- مسیر فایل .ttf برای قلم نیمهتوپر (semibold). در صورت عدم ارائه، از Source Sans Pro Semibold استفاده میشود.
--font-mono- مسیر فایل .ttf برای قلم تکفاصله (monospace). در صورت عدم ارائه، از Source Code Pro Regular استفاده میشود.
--font-mono-bold- مسیر فایل .ttf برای قلم تکفاصله توپر (monospace bold). در صورت عدم ارائه، از Source Code Pro Bold استفاده میشود.
--font-mono-italic- مسیر فایل .ttf برای قلم تکفاصله مورب (monospace italic). در صورت عدم ارائه، از Source Code Pro Italic استفاده میشود.
--font-mono-semibold- مسیر فایل .ttf برای قلم تکفاصله نیمهتوپر (monospace semibold). در صورت عدم ارائه، از Source Code Pro Semibold استفاده میشود.
--pad100- فاصله درونی (حاشیه امن به پیکسل) پیرامون دیاگرام رندرشده.
--animate-interval0- در صورت تعیین، چندین برد به صورت یک فایل SVG بستهبندی میشوند که با این فاصله زمانی (به میلیثانیه) بین هر برد جابجا میشود. فقط با خروجیهای SVG یا GIF قابل استفاده است. برای خروجیهای GIF، در صورت عدم تعیین، مقدار پیشفرض ۱۰۰۰ میلیثانیه است.
--browsertrue- فایل اجرایی مرورگری که دستور پایش باز میکند. تنظیم روی 0 هیچ مرورگری را باز نمیکند.
-l,--layoutdagre- تنظیم موتور چیدمان دیاگرام به رشته ارائهشده. برای مشاهده فهرست گزینههای موجود، دستور layout را اجرا کنید.
-b,--bundletrue- بستهبندی تمام داراییها و لایهها در فایل خروجی svg.
--force-appendixfalse- پیوستی برای نکات ابزار (tooltips) و پیوندها به خروجیهای PNG اضافه میشود زیرا تعاملی نیستند. تنظیم این گزینه روی true، پیوست را به خروجیهای SVG نیز اضافه میکند.
--target- برد هدف برای رندر کردن. برای هدف قرار دادن برد ریشه، یک رشته خالی ارسال کنید. اگر هدف با '*' خاتمه یابد، همراه با تمام سناریوها، مراحل و لایههایش رندر میشود. در غیر این صورت، تنها برد هدف رندر خواهد شد. برای مثال --target='' فقط برای رندر کردن برد ریشه یا --target='layers.x.*' برای رندر لایهٔ 'x' همراه با تمام فرزندان آن.
-d,--debug- چاپ گزارشهای اشکالزدایی.
--img-cachetrue- در حالت پایش، تصاویر استفادهشده در آیکونها برای کامپایلهای بعدی ذخیره میشوند (cache). اگر احتمال تغییر تصاویر وجود دارد، این گزینه باید غیرفعال شود.
--timeout120- حداکثر زمان اجرا (به ثانیه) برای D2 پیش از اتمام مهلت و خروج. هنگام رندر دیاگرامهای بزرگ، افزایش این مقدار توصیه میشود.
--checkfalse- بررسی اینکه آیا فایلهای مشخصشده به درستی قالببندی شدهاند یا خیر.
--saltstring- افزودن مقدار سالت (salt) برای اطمینان از استفاده خروجی از شناسههای یکتا. این گزینه هنگام تولید چندین دیاگرام مشابه برای قرار گرفتن در یک سند HTML کاربرد دارد تا شناسههای تکراری باعث نامعتبر شدن HTML نشوند. مقدار سالت رشتهای است که به شناسهها در خروجی اضافه خواهد شد.
-h,--help- چاپ اطلاعات نحوه استفاده و خروج.
-v,--version- چاپ اطلاعات نسخه و خروج.
--stdout-formatstring- تنظیم قالب خروجی هنگام نوشتن در خروجی استاندارد (stdout). قالبهای پشتیبانیشده: png, svg, ascii, txt, pdf, pptx, gif. فقط زمانی استفاده میشود که خروجی روی stdout (-) تنظیم شده باشد.
--no-xml-tagfalse- حذف تگ XML (مانند <?xml ...?>) از فایلهای خروجی SVG. برای تولید SVG جهت قرار دادن مستقیم در HTML مفید است.
--omit-versionfalse- حذف نسخه D2 از تصویر تولیدشده.
--ascii-modeextended- حالت رندر ASCII برای خروجیهای متنی. گزینهها: 'standard' (کاراکترهای پایه ASCII) یا 'extended' (کاراکترهای یونیکد).
زیردستورها (SUBCOMMANDS)
- layout
- فهرست کردن گزینههای موجود موتورهای چیدمان همراه با راهنمای کوتاه.
- layout [name]
- نمایش راهنمای کامل برای یک موتور چیدمان خاص، شامل گزینههای پیکربندی آن.
- themes
- فهرست کردن پوستههای در دسترس.
- fmt file.d2 ...
- قالببندی تمام فایلهای ارسالشده.
- play file.d2
- باز کردن فایل در playground، یک نمایشگر وب آنلاین (https://play.d2lang.com)
- validate file.d2
- اعتبارسنجی فایل file.d2.
متغیرهای محیطی (ENVIRONMENT VARIABLES)
بسیاری از فلگها را میتوان با متغیرهای محیطی نیز تنظیم کرد.
- D2_WATCH
- فلگ -w[atch] را ببینید.
- D2_LAYOUT
- فلگ -l[ayout] را ببینید.
- D2_THEME
- فلگ -t[heme] را ببینید.
- D2_DARK_THEME
- فلگ --dark-theme را ببینید.
- D2_PAD
- فلگ --pad را ببینید.
- D2_CENTER
- فلگ --center را ببینید.
- D2_SKETCH
- فلگ -s[ketch] را ببینید.
- D2_BUNDLE
- فلگ -b[undle] را ببینید.
- D2_FORCE_APPENDIX
- فلگ --force-appendix را ببینید.
- D2_FONT_REGULAR
- فلگ --font-regular را ببینید.
- D2_FONT_ITALIC
- فلگ --font-italic را ببینید.
- D2_FONT_BOLD
- فلگ --font-bold را ببینید.
- D2_FONT_SEMIBOLD
- فلگ --font-semibold را ببینید.
- D2_FONT_MONO
- فلگ --font-mono را ببینید.
- D2_FONT_MONO_BOLD
- فلگ --font-mono-bold را ببینید.
- D2_FONT_MONO_ITALIC
- فلگ --font-mono-italic را ببینید.
- D2_FONT_MONO_SEMIBOLD
- فلگ --font-mono-semibold را ببینید.
- D2_ANIMATE_INTERVAL
- فلگ --animate-interval را ببینید.
- D2_TIMEOUT
- فلگ --timeout را ببینید.
- D2_CHECK
- فلگ --check را ببینید.
- D2_ASCII_MODE
- فلگ --ascii-mode را ببینید.
- DEBUG
- فلگ -d[ebug] را ببینید.
- IMG_CACHE
- فلگ --img-cache را ببینید.
- HOST
- فلگ -h[ost] را ببینید.
- PORT
- فلگ -p[ort] را ببینید.
- BROWSER
- فلگ --browser را ببینید.
- D2_STDOUT_FORMAT
- فلگ --stdout-format را ببینید.
- D2_NO_XML_TAG
- فلگ --no-xml-tag را ببینید.
- OMIT_VERSION
- فلگ --omit-version را ببینید.
همچنین ببینید (SEE ALSO)
نویسندگان (AUTHORS)
D2 contributors
| September 24, 2026 | Linux 6.12.107+deb13-amd64 |