پیش‌نمایش Markdown آنلاین و تبدیل به HTML

متن را در کادر Markdown بنویسید یا جای‌گذاری کنید. با هر تغییر، کادر پیش‌نمایش بلافاصله نتیجه را نشان می‌دهد و نیازی به زدن دکمه نیست. ابزار با یک متن نمونهٔ فارسی و انگلیسی باز می‌شود که بیشتر امکانات پشتیبانی‌شده را نشان می‌دهد؛ آن را با دکمهٔ «پاک کردن» یا کلید Esc پاک کنید و متن خودتان را بنویسید. دکمهٔ «متن نمونه» هر وقت خواستید آن را برمی‌گرداند.

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

دکمهٔ «کپی HTML» کد HTML ساخته‌شده را در کلیپ‌بورد قرار می‌دهد. این کد تمیز است و هیچ کلاس استایلی از سایت ایران‌کلاد ندارد؛ فقط تگ‌های استاندارد مثل h1‏، p‏، ul‏، table و a با ویژگی dir با مقدار auto برای جهت درست متن. پس می‌توانید آن را مستقیم در سایت یا قالب خودتان بگذارید و با CSS خودتان ظاهرش را تنظیم کنید.

یک روش کاربردی برای نوشتن ایمیل یا اطلاعیهٔ قالب‌بندی‌شده هم همین است: متن را با Markdown بنویسید، در پیش‌نمایش بررسی کنید و HTML آن را در ویرایشگری که حالت کد دارد جای‌گذاری کنید. به این ترتیب تیترها، فهرست‌ها و لینک‌ها بدون درگیری با دکمه‌های ویرایشگر گرافیکی مرتب می‌شوند و متن خام هم برای بایگانی خوانا باقی می‌ماند.

این ابزار سبک است ولی پرکاربردترین بخش‌های Markdown و جدول‌های سبک GitHub را پشتیبانی می‌کند؛ همان چیزهایی که برای README، یادداشت، مستندات کوتاه یا پیام کافی است. جدول زیر دقیقاً مشخص می‌کند چه چیزی رندر می‌شود:

Markdown با متن فارسی مشکلی ندارد، اما چند نکته کار را راحت‌تر می‌کند. علامت‌های Markdown باید با نویسه‌های لاتین تایپ شوند؛ ستارهٔ صفحه‌کلید فارسی گاهی نویسهٔ دیگری است و پررنگ کار نمی‌کند. بین علامت # و متن تیتر حتماً یک فاصله بگذارید. برای نیم‌فاصله در کلماتی مثل «می‌شود» از نویسهٔ نیم‌فاصلهٔ واقعی استفاده کنید تا شمارش کلمات هم درست‌تر شود.

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

برای بلوک‌های کد، زبان برنامه‌نویسی را بعد از سه بک‌تیک بنویسید؛ این ابزار رنگ‌آمیزی کد ندارد، اما بیشتر پلتفرم‌ها از همین نام برای رنگ‌آمیزی استفاده می‌کنند و نوشتنش عادت خوبی است.

خیر. صفحه یک بار از سرور ایران‌کلاد بارگذاری می‌شود و تبدیل Markdown به HTML به‌طور کامل با جاوااسکریپت داخل مرورگر شما انجام می‌شود. کد این ابزار هیچ درخواست شبکه‌ای نمی‌فرستد و متن را در کوکی یا حافظهٔ مرورگر ذخیره نمی‌کند. با بستن یا تازه کردن صفحه، متن شما پاک می‌شود و به متن نمونه برمی‌گردد؛ پس پیش‌نویس‌های مهم را جای دیگری هم نگه دارید.

ابزار پیش از تبدیل، همهٔ علامت‌های HTML را خنثی می‌کند؛ یعنی اگر تگ HTML یا اسکریپت در متن بنویسید، به‌صورت متن نمایش داده می‌شود و اجرا نمی‌شود. نتیجه پیش از نمایش یک بار دیگر هم با فهرست مجاز تگ‌ها و ویژگی‌ها بازسازی می‌شود و هر چیز خارج از آن حذف می‌شود. لینک‌ها فقط با http‏، https‏، mailto، اسلش، # یا مسیر نسبی پذیرفته می‌شوند و آدرس‌هایی مثل javascript: یا data: به متن ساده تبدیل می‌شوند. این دو لایه جلوی سوءاستفاده از پیش‌نمایش را می‌گیرد.

اگر می‌خواهید خودتان مطمئن شوید که چیزی ارسال نمی‌شود، ابزار توسعه‌دهندهٔ مرورگر را باز کنید و در زبانهٔ Network هنگام تایپ نگاه کنید؛ هیچ درخواستی ثبت نمی‌شود. ابزار حتی پس از قطع اینترنت هم به کار خود ادامه می‌دهد، چون همهٔ منطق آن همراه صفحه بارگذاری شده است.

اگر با سرور و نرم‌افزار کار می‌کنید، Markdown احتمالاً هر روز جلوی چشم شماست. چند کاربرد رایج که این ابزار برای پیش‌نمایش سریعشان مناسب است:

یکی از مفیدترین کارهایی که هر تیم کوچک می‌تواند انجام دهد، نوشتن یک فایل مستندات عملیاتی یا runbook برای هر سرور است. وقتی ساعت سه بامداد سرویس از کار می‌افتد، کسی حوصلهٔ جست‌وجو در پیام‌های قدیمی را ندارد؛ یک فایل Markdown که می‌گوید سرور چه کاری می‌کند، کجا لاگ می‌نویسد و چطور راه‌اندازی دوباره می‌شود، زمان بازیابی را چند برابر کوتاه می‌کند.

ساختار پیشنهادی ما ساده است: یک تیتر سطح یک با نام سرور، سپس تیترهای سطح دو برای «مشخصات»، «سرویس‌ها و پورت‌ها»، «محل لاگ‌ها»، «پشتیبان‌گیری و بازیابی» و «کارهای اضطراری». زیر هر کدام، دستورهای دقیق را در بلوک کد بنویسید تا مستقیم قابل کپی باشند. همهٔ این عناصر در همین ابزار پیش‌نمایش می‌شوند.

این فایل را کنار کد پروژه در مخزن Git نگه دارید تا تغییراتش تاریخچه داشته باشد. هر بار که پورتی در فایروال باز می‌کنید یا سیاست پشتیبان‌گیری را عوض می‌کنید، یک خط به آن اضافه کنید. مستنداتی که به‌روز نشوند، در لحظهٔ بحران بیشتر گمراه می‌کنند تا کمک.

اگر به تبدیل کامل‌تر یا خودکار نیاز دارید، pandoc قوی‌ترین ابزار تبدیل اسناد است و Markdown را به HTML‏، PDF‏، Word و قالب‌های دیگر تبدیل می‌کند. برای بررسی سبک نوشتار و خطاهای رایج در مستندات پروژه، ابزارهای lint مخصوص Markdown وجود دارند که در خط لولهٔ CI قابل اجرا هستند.

برای خواندن سریع یک فایل Markdown روی سرور، همان less یا cat کافی است؛ چون Markdown خام هم خواناست. این همان مزیتی است که باعث شده مستندات سرور و فایل‌های راهنما اغلب با Markdown نوشته شوند.

بیشتر مشکلات نمایش Markdown از چند اشتباه کوچک ناشی می‌شود که با یک نگاه به پیش‌نمایش پیدا می‌شوند. به همین دلیل پیشنهاد می‌کنیم پیش از ثبت یک README یا انتشار یک مطلب، متن را یک بار در پیش‌نمایش ببینید؛ به‌خصوص اگر بلوک کد یا فهرست طولانی دارد که یک خط خالی جاافتاده می‌تواند ظاهر کل آن را به هم بریزد. رایج‌ترین اشتباه‌ها این‌ها هستند:

این ابزار برای پیش‌نمایش سریع و متن‌های کوتاه تا متوسط ساخته شده و جایگزین یک ویرایشگر کامل Markdown نیست. تصویر بارگذاری نمی‌شود، رنگ‌آمیزی کد، پانویس و فرمول ریاضی ندارد و HTML خام را رندر نمی‌کند. متن ذخیره نمی‌شود و با تازه کردن صفحه از بین می‌رود. اگر مستندات طولانی یا تیمی می‌نویسید، یک ویکی یا ویرایشگر هم‌زمان روی سرور خودتان انتخاب بهتری است.

برای میزبانی چنین ابزارهایی، سرور ابری ایران‌کلاد با پرداخت ساعتی از ۱٬۱۰۰ تومان در ساعت برای پلن mini شروع می‌شود. Gitea را می‌توانید با نصب یک‌کلیکی راه‌اندازی کنید و برای ابزارهایی مثل Wiki.js و BookStack، صفحهٔ هر کدام روش نصب دستی روی سرور را توضیح می‌دهد. مقایسهٔ پلن‌ها در صفحهٔ قیمت‌ها آمده است.