راهنمای محصول و پیاده‌سازی

ورق

ابزار مطالعه، ویرایش و اشتراک‌گذاری متن Markdown به فارسی و انگلیسی، در یک فایل HTML قابل حمل.

ایده و دلیل ساخت

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

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

چطور استفاده کنیم؟

  1. ZIP را استخراج کنید و از بالای همین صفحه، نسخهٔ پیوست یا نسخهٔ چک‌لیست را باز کنید. خود برنامه یک سند خوش‌آمدگویی دارد.
  2. با «باز کردن MD» فایل را انتخاب کنید یا آن را روی صفحه بیندازید. برای امتحان، از سند نمونه استفاده کنید.
  3. با فهرست کنار صفحه میان تیترها جابه‌جا شوید. با «جهت خودکار» جهت هر بند و سلول جداگانه تعیین می‌شود. پوستهٔ روشن و تیره، اندازهٔ متن و حالت تمرکز از نوار بالا تغییر می‌کنند.
  4. برای اصلاح متن یا چسباندن Markdown روی «ویرایش» بزنید. پیش‌نمایش با کمی مکث به‌روز می‌شود. «ذخیره MD» متن فعلی را به صورت فایل دانلود می‌کند.
  5. برای ارسال نسخهٔ خواندنی، «خروجی HTML» را بزنید. «چاپ / PDF» پنجرهٔ چاپ مرورگر را باز می‌کند و گزینهٔ Save as PDF فایل PDF می‌سازد.

ورق چطور کار می‌کند؟

ورودی و تبدیل

برنامه فایل‌های .md، .markdown، .mdown و .txt را تا سقف ۱۰ مگابایت با API فایل مرورگر می‌خواند. Marked 17.0.5 که داخل همان HTML قرار دارد، متن را با پشتیبانی از قابلیت‌های GFM مانند جدول و چک‌لیست تبدیل می‌کند. برنامه پیش از نمایش، درخت HTML را از روی فهرست عناصر و ویژگی‌های مجاز بازسازی می‌کند. نمایش محتوا به سرور یا نصب نرم‌افزار نیاز ندارد.

نمایش و پیمایش

عنوان‌های H1 تا H3 فهرست کناری را می‌سازند. هر جدول در ظرف قابل اسکرول قرار می‌گیرد و بلوک کد چپ‌به‌راست است و دکمهٔ کپی دارد. نوار پیشرفت بر اساس موقعیت اسکرول صفحه به‌روز می‌شود. زمان مطالعه تقریبی است و از شمارش واژه‌های متن خام با نرخ ۲۰۰ واژه در دقیقه به دست می‌آید. فونت کلمه تعبیه شده و فایل فونت دلخواه تا ۵ مگابایت قابل انتخاب است.

خروجی و ذخیره‌سازی

خروجی HTML متن رندرشده، جهت، پوسته، اندازهٔ متن و CSS فونت را همراه خود می‌برد و برای خواندن مستقل طراحی شده است. خروجی MD متن خام و تغییرات را نگه می‌دارد. نسخهٔ چک‌لیست هنگام باز کردن فایل، کلیدی از نام و متن ورودی می‌سازد و پیش‌نویس را در localStorage ذخیره و بازیابی می‌کند. اگر مرورگر ذخیرهٔ محلی را مسدود کند، دانلود MD راه نگهداری تغییرات است.

محدودهٔ نسخهٔ فعلی

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

فهرست فایل‌ها

فایلکاربرد
Markdown_Reader(1)(1).htmlنسخهٔ پیوست و نقطهٔ شروع پیشنهادی برای مطالعه و ویرایش.
Archive/Markdown_Reader.htmlنسخهٔ اولیهٔ پیدا شده. محتوای فایل با نسخهٔ پیوست یکسان است.
Archive/Markdown_Reader(1).htmlنسخهٔ دیگری با محتوای بایت‌به‌بایت یکسان با نسخهٔ پیوست.
Archive/My Resume/Markdown_Reader.htmlنسخهٔ متفاوت با چک‌لیست تعاملی، بازیابی پیش‌نویس و دکمهٔ ذخیرهٔ سریع MD.
Examples/Varaq_Demo.mdنمونهٔ همراه بسته برای آزمون متن دوزبانه، جدول، کد و چک‌لیست.
START_HERE.htmlهمین راهنمای محصول، استفاده و پیاده‌سازی.