نام (NAME)

crystal-docs - تولید مستندات برای پروژه‌های زبان برنامه‌نویسی کریستال

خلاصه دستور (SYNOPSIS)

crystal docs [options] [programfile] [--] [arguments]

توضیحات (DESCRIPTION)

تولید مستندات از روی توضیحات و کامنت‌ها با استفاده از زیرمجموعه‌ای از Markdown. خروجی با قالب HTML در پوشه ایجادشده docs/ ذخیره می‌شود. اطلاعات بیشتر درباره قواعد و شیوه‌نامه‌های مستندسازی را می‌توانید در نشانی زیر بیابید: https://crystal-lang.org/docs/conventions/documenting_code.html.

گزینه‌ها (OPTIONS)

--project-name NAME

تنظیم نام پروژه. در صورت در دسترس بودن، مقدار پیش‌فرض از فایل shard.yml استخراج می‌شود.

در صورتی که هیچ مقدار پیش‌فرضی یافت نشود، تعیین این گزینه الزامی است.

--project-version VERSION

تنظیم نسخه پروژه. در صورت در دسترس بودن، مقدار پیش‌فرض از کامیت فعلی git یا فایل shard.yml استخراج می‌شود.

در صورتی که هیچ مقدار پیش‌فرضی یافت نشود، تعیین این گزینه الزامی است.

--json-config-url URL

تنظیم نشانی اینترنتی (URL) اشاره‌کننده به یک فایل پیکربندی (برای شناسایی نسخه‌ها استفاده می‌شود).

--source-refname REFNAME

تنظیم نام مرجع منبع (مانند تگ git، هش کامیت). در صورت در دسترس بودن، مقدار پیش‌فرض از کامیت فعلی git استخراج می‌شود.

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

--source-url-pattern URL

تنظیم الگوی نشانی (URL) برای پیوندهای کد منبع. در صورت در دسترس بودن ریموت‌های git (ریموت origin یا اولین ریموت موجود) و شناسایی الگوی URL ارائه‌دهنده، مقدار پیش‌فرض از آن استخراج می‌شود.

تگ‌های جایگزینی پشتیبانی‌شده:

%{refname}

مرجع یا شناسه کامیت

%{path}

مسیر فایل منبع در داخل مخزن

%{filename}

نام پایه (basename) فایل منبع

%{line}

شماره خط

-o DIR, --output DIR

تنظیم دایرکتوری خروجی (پیش‌فرض: ./docs).

-b URL, --canonical-base-url URL

مشخص کردن نشانی اینترنتی (URL) ترجیحی با استفاده از عنصر پیوند rel="canonical".

-b URL, --sitemap-base-url URL

تنظیم URL پایه برای نقشه سایت (sitemap). نقشه سایت تنها در صورتی تولید می‌شود که این گزینه تنظیم شده باشد.

--sitemap-priority PRIO

تنظیم اولویت تخصیص‌یافته به ورودی‌های نقشه سایت (پیش‌فرض: 1.0).

--sitemap-changefreq FREQ

تنظیم دوره تغییرات (changefreq) تخصیص‌یافته به ورودی‌های نقشه سایت (پیش‌فرض: never).

2026-07-23

crystal 1.21.0