کتابخانه
marked یه کتابخانه جاوااسکریپته که متن مارک داون رو به HTML تبدیل می کنه. توی مرورگر، روی سرور با Node.js و حتی از خط فرمان کار می کنه. هر جا بخوای متن مارک داونی رو توی سایت یا پنل مدیریت به شکل صفحه نشون بدی، marked یه گزینه ساده و آماده برای همین کاره.
نسخه رسمی و بدون تغییر، از منبع رسمی با مجوز MIT؛ هش هر فایل با منبع بررسی شده است.
۱۰۸ کیلوبایت· ۶ فایل· انتشار
SHA-256: 9eb730d2362ae1a8c6201698f17009e16671be6946d3d06503ddc0575283db7c
مارک داون نوشتنش راحته، ولی مرورگر چیزی ازش نمی فهمه. اگه توضیح محصول، مستندات، پیام تیکت یا یادداشت های پنلت رو با مارک داون ذخیره کرده باشی، یه جایی باید تبدیلش کنی به عنوان، لیست، لینک و جدول HTML. marked همین کار رو می کنه. با مجوز MIT منتشر شده، یعنی توی پروژه های شخصی و تجاری می تونی راحت ازش استفاده کنی.
هم قواعد استاندارد CommonMark رو می فهمه، هم گونه GitHub Flavored Markdown رو که جدول و لیست تیک دار هم توشه. بیشتر این جاها به کارت می آد: صفحه مستندات یه افزونه یا API، نمایش README داخل سایت، پیش نمایش زنده کنار یه جعبه متن، پنل پشتیبانی که کاربرها توش با مارک داون می نویسن، یا یه بلاگ ایستا که محتواش فایل متنیه. چون به وردپرس وابسته نیست، توی پروژه های Node و فرانت اند هم همین طور کار می کنه.
یه نکته رو از اول جدی بگیر: marked خروجی رو پاک سازی نمی کنه. اگه متن از ورودی کاربرها می آد، قبل از نمایش خروجی HTML باید با یه کتابخانه پاک سازی مثل DOMPurify ازش رد بشه، وگرنه راه برای تزریق اسکریپت باز می شه. برای متنی که خودت نوشتی نگرانی کمتره، ولی برای ورودی عمومی نباید ازش گذشت.
دو جا لازم نیست سراغش بری. یکی وقتی یه صفحه ثابت داری و راحت می تونی HTML رو مستقیم بنویسی. یکی هم وقتی ویرایشگر بصری می خوای که کاربر چیزی شبیه ورد ببینه. marked فقط یه طرفه کار می کنه، یعنی از مارک داون به HTML، نه برعکس. برای سایت های فارسی هم یه چیز دیگه هست: خروجی خودش جهت متن رو عوض نمی کنه. باید با CSS یا ویژگی dir راست چینش کنی و بلوک های کد رو چپ چین نگه داری.
اگه بخوای رفتارش رو عوض کنی، مثلا لینک ها توی تب جدید باز بشن یا عنوان ها کلاس خاصی بگیرن، marked برای همین رندرر و افزونه های خودش رو داره. هایلایت کد رو هم معمولا با یه کتابخانه جدا کنارش می ذارن. نسخه های رسمی و بدون تغییر marked توی مخزن داخلی ما هم هست، پس وقتی دسترسی به npm یا CDN های خارجی کند یا قطعه، می تونی از همین جا بگیری و روی هاست خودت بذاری.
راه انداختنش چند قدم بیشتر نیست:
marked یه کتابخانه جاوااسکریپته که متن مارک داون رو به HTML تبدیل می کنه. وقتی محتوا رو با علامت های ساده مثل # و ستاره می نویسی و می خوای توی سایت به شکل عنوان، لیست، لینک و جدول نشون داده بشه، سراغ marked می ری. هم توی مرورگر کار می کنه، هم روی سرور.
خودش خروجی رو پاک سازی نمی کنه. اگه متن مارک داون از کاربرها یا منبع نامطمئن می آد، قبل از گذاشتن توی صفحه باید با ابزاری مثل DOMPurify تمیزش کنی، وگرنه کد مخرب می تونه توی صفحه اجرا بشه. برای متنی که خودت نوشتی و کنترلش دست خودته، این خطر خیلی کمتره.
بله، متن فارسی رو بدون مشکل تبدیل می کنه، ولی جهت نمایش رو خودت باید با CSS یا ویژگی dir مشخص کنی. المانی که خروجی رو توش می ذاری راست به چپ باشه و بلوک های کد چپ به راست بمونن تا ظاهر کد به هم نریزه.
ویرایشگر وردپرس برای نوشتن و ذخیره محتوا توی خود وردپرسه، ولی کار marked فقط تبدیل مارک داون به HTML هست. اگه بخشی از سایتت مثل مستندات یا پنل تیکت متن مارک داون داره و باید نمایش داده بشه، marked به کارت می آد. برای نوشتن معمولی مطلب لازمش نداری.
marked با مجوز MIT منتشر شده که استفاده توی پروژه های شخصی و تجاری رو اجازه می ده. فقط باید اعلان حق نشر و متن مجوز رو همراه کد نگه داری. اگه افزونه یا کتابخانه جانبی هم کنارش می ذاری، مجوز اون ها رو هم جدا نگاه کن.
نام کتابخانه، افزونه یا قالب را بفرستید؛ پس از بررسی، نسخه‌های رسمی آن به مخزن اضافه می‌شود.