منصوبے کے بارے میں

remark مارک ڈاؤن پروسیسر ہے جو پلگ انز کے گرد بنایا گیا ہے، اور unified اجتماعی کا حصہ ہے۔ مارک ڈاؤن کو سادہ متن سمجھنے کے بجائے، یہ اسے ایک منظم خلاصہ نحوی درخت (mdast) میں پارس کرتا ہے، جسے پلگ ان مواد کو دوبارہ سیریلائز کرنے سے پہلے جانچ اور تبدیل کر سکتے ہیں۔ مونو ریپوزٹری میں کئی پیکجز شامل ہیں: remark-parse (مارک ڈاؤن سے نحوی درخت)، remark-stringify (نحوی درخت سے واپس مارک ڈاؤن)، remark (unified، parse اور stringify کو ملا کر مارک ڈاؤن سے مارک ڈاؤن کے کام کے لیے)، اور remark-cli (مارک ڈاؤن فائلوں کو جانچنے اور فارمیٹ کرنے کے لیے ایک کمانڈ لائن انٹرفیس)۔ README میں بیان کردہ اہم خصوصیات: - بطور ڈیفالٹ CommonMark کے مطابق، جبکہ GFM یا MDX کی معاونت پلگ انز کے ذریعے دستیاب ہے۔ - AST پر مبنی پروسیسنگ پروگراماتی جانچ اور تبدیلی کو سیدھا بناتی ہے۔ - 150+ پلگ انز کا ایکو سسٹم، بشمول remark-gfm (گٹ ہب فلیورڈ مارک ڈاؤن)، remark-lint (اسٹائل چیکنگ)، remark-toc (فہرست مواد کی تخلیق) اور remark-rehype (مارک ڈاؤن سے HTML)۔ - سرورز، کلائنٹس، CLIs اور Deno پر استعمال کے قابل۔ عام استعمالات میں مارک ڈاؤن کو HTML میں تبدیل کرنا (اکثر rehype ایکو سسٹم اور rehype-sanitize کے ساتھ)، GFM اور YAML frontmatter جیسی نحوی توسیعات کو فعال کرنا، مستقل مزاجی کے لیے مارک ڈاؤن کی لِنٹنگ، اور CLI اور package.json میں remarkConfig انٹری کے ذریعے پروجیکٹ میں مارک ڈاؤن فائلوں کو فارمیٹ کرنا شامل ہیں۔ یہ پروجیکٹ مکمل طور پر TypeScript کے ساتھ ٹائپ کیا گیا ہے، اور mdast کی اقسام @types/mdast کے ذریعے دستیاب ہیں۔ README میں سیکیورٹی کے تحفظات نوٹ کیے گئے ہیں: کیونکہ مارک ڈاؤن HTML بن سکتا ہے، نامناسب ہینڈلنگ صارفین کو کراس سائٹ اسکرپٹنگ کا نشانہ بنا سکتی ہے، لہٰذا HTML تیار کرتے وقت rehype-sanitize تجویز کیا جاتا ہے؛ بڑے یا مخالفانہ ان پٹ کارکردگی یا کریش کے مسائل بھی پیدا کر سکتے ہیں، اس لیے ان پٹ کا حجم محدود کرنے اور پروسیسنگ علیحدہ تھریڈ یا ورکر میں کرنے کا مشورہ دیا جاتا ہے۔ پلگ انز کا خطرہ انفرادی طور پر جانچا جانا چاہیے۔