TypeScript - تبدیل فایل .d.ts به مستندات HTML

من یک فایل اعلان تایپاسکریپت (.d.ts) دارم که شامل مستندات تمام توابع یک API است. من میخواهم مستندات را در یک وبسایت (.html) نمایش دهم.

آیا راهی وجود دارد که این کار را انجام داد؟ (تبدیل یک فایل .d.ts به .html زیبا)

(توجه: من فایلهای .ts را ندارم، فقط فایل .d.ts را دارم)

پاسخ شماره ۱

به این پروژه نوگت نگاهی بیندازید:

https://github.com/TypeStrong/typedoc

TypeDoc بر روی Node.js اجرا میشود و بهصورت یک بسته NPM در دسترس است. شما میتوانید TypeDoc را مانند معمول در دایرکتوری پروژه خود نصب کنید:

npm install typedoc --save-dev

مانند کامپایلر TypeScript، TypeDoc همراه با یک باینری ارائه میشود که در صورت نصب TypeDoc به عنوان یک ماژول سراسری، میتوان از هر جایی آن را فراخوانی کرد. نام فایل اجرایی typedoc است.

npm install typedoc --global
typedoc

استفاده

پوسته

TypeDoc بیشتر آرگومانهای خط فرمانی که کامپایلر TypeScript میپذیرد را قبول میکند. یک تفاوت اصلی این است که میتوان به جای فایلهای جداگانه، یک دایرکتوری کامل را به تولیدکننده مستندات ارسال کرد. بنابراین برای ایجاد مستندات برای یک پروژه کامل، کافی است که تایپ کنید:

typedoc --out path/to/documentation/ path/to/typescript/project/