نحوه استفاده
- در ویرایشگر Markdown تایپ کنید یا روی «یک نمونه امتحان کنید» بزنید تا سندی با جدول‌ها و فهرست کارها بارگذاری شود.
- هنگام تایپ، پیش‌نمایش به‌روزرسانی می‌شود. برای دیدن نشانه‌گذاری تولیدشده، به «منبع HTML» بروید.
- پشتیبانی از GitHub Flavored Markdown یا شکست خط تکی را متناسب با جایی که متن منتشر می‌شود روشن یا خاموش کنید.
- HTML را در CMS یا ایمیل کپی کنید یا نتیجه را به‌صورت فایل .html یا .md دانلود کنید.
نحوه کار
Markdown با marked پردازش می‌شود؛ یک تجزیه‌گر متن‌باز پرکاربرد که از مشخصات CommonMark پیروی می‌کند و با فعال‌بودن گزینه GFM، از GitHub Flavored Markdown پشتیبانی می‌کند: جدول‌های pipe با ترازبندی ستون، فهرست وظایف، ~~strikethrough~~ و پیوندهای خودکار برای URLهای ساده. پانوشت‌ها، فرمول‌های ریاضی و نمودارهای Mermaid جزو این مشخصات نیستند و به‌صورت متن ساده نمایش داده می‌شوند.
Markdown ممکن است حاوی HTML خام باشد و آن HTML بدون تغییر عبور داده می‌شود، همان‌طور که بیشتر نمایش‌دهنده‌های Markdown انجام می‌دهند. برای حفظ امنیت شما، پیش‌نمایش هرگز در این صفحه قرار داده نمی‌شود. این پیش‌نمایش درون یک قاب sandbox رندر می‌شود که اجازه اجرای اسکریپت، ارسال فرم، بازکردن پاپ‌آپ یا دسترسی به این سایت را ندارد و سیاست امنیت محتوای آن، اسکریپت‌ها، استایل‌شیت‌های خارجی، فونت‌ها و قاب‌ها را مسدود می‌کند. تگ <script> یا ویژگی onclick در Markdown شما در منبع HTML نمایش داده می‌شود اما هرگز اجرا نمی‌شود. پیوندها در پیش‌نمایش نشان داده می‌شوند اما باز نمی‌شوند؛ برای دنبال‌کردن پیوند، URL را کپی کنید.
پیش‌نمایش از استایل‌شیت خنثی مشابه نمایش‌دهنده‌های رایج README استفاده می‌کند؛ وب‌سایت شما یا GitHub ممکن است همان HTML را متفاوت استایل دهد. HTML کپی‌شده قطعه خام بدون استایل است؛ فایل .html دانلودشده یک استایل‌شیت پایه اضافه می‌کند تا شبیه پیش‌نمایش به نظر برسد. HTML دانلودشده یا کپی‌شده پاک‌سازی نمی‌شود؛ بنابراین اگر اسکریپت داشته باشد، هر جا که آن را جای‌گذاری یا باز کنید اجرا خواهد شد.
نمونه‌ها
بررسی README پیش از push کردن
فایل README.md را جای‌گذاری کنید تا مطمئن شوید ستون‌های جدول تراز هستند، فهرست وظایف به‌صورت چک‌باکس نمایش داده می‌شود و بلوک‌های کد به‌درستی محصور شده‌اند، پیش از آنکه فایل به GitHub برود.
نوشتن برای یک CMS که HTML می‌پذیرد
پیش‌نویس یک نوشته وبلاگ را در Markdown بنویسید، سپس «کپی HTML» را بزنید و تگ‌های <h2>، <p> و <ul> را در ویرایشگر HTML سیستم مدیریت محتوا جای‌گذاری کنید.
شکست خط به سبک چت
متن برنامه چت خط‌هایی دارد که با شکست خط تکی از هم جدا شده‌اند. روشن‌کردن «در نظر گرفتن شکست خط تکی به‌عنوان <br>» آن خط‌ها را جدا نگه می‌دارد، به‌جای آنکه در یک پاراگراف ادغام کند.
پرسش‌های متداول
آیا جای‌گذاری Markdown از منبع ناشناس امن است؟
بله، برای پیش‌نمایش امن است. HTML رندرشده در یک قاب sandbox با اسکریپت‌های غیرفعال نمایش داده می‌شود، بنابراین حتی تگ <script> یا یک event handler در متن اینجا هیچ کاری انجام نمی‌دهد. مراقب باشید HTML خروجی را کجا جای‌گذاری می‌کنید، چون پاک‌سازی نشده است.
چرا تصاویر من نمایش داده نمی‌شوند؟
تصاویر از وب‌سایت‌های دیگر به‌طور پیش‌فرض مسدود می‌شوند تا پیش‌نمایش هیچ درخواست شبکه‌ای ندهد. برای نمایش آن‌ها گزینه «بارگذاری تصاویر از وب‌سایت‌های دیگر» را روشن کنید. مسیرهای نسبی مانند ./docs/screenshot.png کار نمی‌کنند زیرا فایل‌ها اینجا نیستند.
آیا از پانوشت‌ها، ریاضیات یا نمودارها پشتیبانی می‌کند؟
خیر. این ابزار از CommonMark و GitHub Flavored Markdown (جدول‌ها، فهرست کارها، خط‌خوردگی، پیوندهای خودکار) پشتیبانی می‌کند. پانوشت‌ها، ریاضیات LaTeX و نمودارهای Mermaid افزونه‌هایی هستند که این پیش‌نمایش آن‌ها را به‌صورت متن ساده باقی می‌گذارد.
چرا یک شکست خط تکی خط جدیدی شروع نمی‌کند؟
در Markdown استاندارد، یک شکست خط تکی داخل پاراگراف به‌عنوان فاصله در نظر گرفته می‌شود. خط را با دو فاصله تمام کنید، یک خط خالی بگذارید، یا گزینه «شکست خط تکی به‌صورت <br> در نظر گرفته شود» را روشن کنید.
حریم خصوصی
Markdown در مرورگر شما تبدیل می‌شود و بارگذاری یا ذخیره نمی‌شود. پیش‌نمایش هیچ چیزی را از اینترنت بارگیری نمی‌کند مگر اینکه تصاویر از وب‌سایت‌های دیگر را مجاز کنید؛ در آن صورت آن تصاویر مستقیماً از میزبان‌هایشان درخواست می‌شوند.