'\" t
.\"     Title: crystal-docs
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-07-23
.\"    Manual: Crystal Compiler Command Line Reference Guide
.\"    Source: crystal 1.21.0
.\"  Language: Persian
.
.TH "CRYSTAL\-DOC" "1" "2026-07-23" "crystal 1.21.0" "Crystal Compiler Command Line Reference Guide"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "نام (NAME)"
crystal-docs \- تولید مستندات برای پروژه‌های زبان برنامه‌نویسی کریستال
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBcrystal docs\fP [options] [programfile] [\-\-] [arguments]
.SH "توضیحات (DESCRIPTION)"
.sp
تولید مستندات از روی توضیحات و کامنت‌ها با استفاده از زیرمجموعه‌ای از Markdown. خروجی با قالب HTML در پوشه ایجادشده \f(CRdocs/\fP ذخیره می‌شود. اطلاعات بیشتر درباره قواعد و شیوه‌نامه‌های مستندسازی را می‌توانید در نشانی زیر بیابید:\c
.URL "https://crystal\-lang.org/docs/conventions/documenting_code.html" "" "."
.SH "گزینه‌ها (OPTIONS)"
.sp
\fB\-\-project\-name\fP \fINAME\fP
.RS 4
تنظیم نام پروژه. در صورت در دسترس بودن، مقدار پیش‌فرض از فایل \f(CRshard.yml\fP استخراج می‌شود.
.sp
در صورتی که هیچ مقدار پیش‌فرضی یافت نشود، تعیین این گزینه الزامی است.
.RE
.sp
\fB\-\-project\-version\fP \fIVERSION\fP
.RS 4
تنظیم نسخه پروژه. در صورت در دسترس بودن، مقدار پیش‌فرض از کامیت فعلی git یا فایل \f(CRshard.yml\fP استخراج می‌شود.
.sp
در صورتی که هیچ مقدار پیش‌فرضی یافت نشود، تعیین این گزینه الزامی است.
.RE
.sp
\fB\-\-json\-config\-url\fP \fIURL\fP
.RS 4
تنظیم نشانی اینترنتی (URL) اشاره‌کننده به یک فایل پیکربندی (برای شناسایی نسخه‌ها استفاده می‌شود).
.RE
.sp
\fB\-\-source\-refname\fP \fIREFNAME\fP
.RS 4
تنظیم نام مرجع منبع (مانند تگ git، هش کامیت). در صورت در دسترس بودن، مقدار پیش‌فرض از کامیت فعلی git استخراج می‌شود.
.sp
اگر این گزینه مشخص نشود و نتوان آن را به‌طور خودکار تشخیص داد، تولیدکننده مستندات قادر به ایجاد پیوندهای کد منبع نخواهد بود.
.RE
.sp
\fB\-\-source\-url\-pattern\fP \fIURL\fP
.RS 4
تنظیم الگوی نشانی (URL) برای پیوندهای کد منبع. در صورت در دسترس بودن ریموت‌های git (ریموت \f(CRorigin\fP یا اولین ریموت موجود) و شناسایی الگوی URL ارائه‌دهنده، مقدار پیش‌فرض از آن استخراج می‌شود.
.sp
تگ‌های جایگزینی پشتیبانی‌شده:
.sp
\fB%{refname}\fP
.RS 4
مرجع یا شناسه کامیت
.RE
.sp
\fB%{path}\fP
.RS 4
مسیر فایل منبع در داخل مخزن
.RE
.sp
\fB%{filename}\fP
.RS 4
نام پایه (basename) فایل منبع
.RE
.sp
\fB%{line}\fP
.RS 4
شماره خط
.RE
.sp
اگر این گزینه مشخص نشود و نتوان آن را به‌طور خودکار تشخیص داد، تولیدکننده مستندات قادر به ایجاد پیوندهای کد منبع نخواهد بود.
.RE
.sp
\fB\-o\fP \fIDIR\fP, \fB\-\-output\fP \fIDIR\fP
.RS 4
تنظیم دایرکتوری خروجی (پیش‌فرض: \f(CR./docs\fP).
.RE
.sp
\fB\-b\fP \fIURL\fP, \fB\-\-canonical\-base\-url\fP \fIURL\fP
.RS 4
مشخص کردن نشانی اینترنتی (URL) ترجیحی با استفاده از عنصر پیوند \f(CRrel="canonical"\fP.
.RE
.sp
\fB\-b\fP \fIURL\fP, \fB\-\-sitemap\-base\-url\fP \fIURL\fP
.RS 4
تنظیم URL پایه برای نقشه سایت (sitemap). نقشه سایت تنها در صورتی تولید می‌شود که این گزینه تنظیم شده باشد.
.RE
.sp
\fB\-\-sitemap\-priority\fP \fIPRIO\fP
.RS 4
تنظیم اولویت تخصیص‌یافته به ورودی‌های نقشه سایت (پیش‌فرض: 1.0).
.RE
.sp
\fB\-\-sitemap\-changefreq\fP \fIFREQ\fP
.RS 4
تنظیم دوره تغییرات (changefreq) تخصیص‌یافته به ورودی‌های نقشه سایت (پیش‌فرض: \f(CRnever\fP).
.RE