Skip to main content

چگونه از Markdown (CommonMark) در ویکی ما استفاده کنیم

توجه: این سند ترجمه خودکار نسخه اصلی انگلیسی است.

این صفحه یک "برگه تقلب" کوتاه برای قالب‌بندی صفحات در ویکی ما است، جایی که محتوا با CommonMark Markdown نوشته می‌شود.

قوانین اساسی

  • با جملات ساده و کوتاه بنویسید.
  • صفحه را قابل مرور (scannable) کنید: عناوین + لیست‌ها + جداول.
  • یک بخش = یک ایده. از نوشتن "دیوارهای متنی" (پاراگراف‌های خیلی طولانی) خودداری کنید.

عناوین

برای ساختاردهی از ## / ### / #### استفاده کنید.

## بخش
### زیربخش
#### زیر-زیربخش

پررنگ، ایتالیک، کد درون‌خطی

**پررنگ**
*ایتالیک*
`کد/فیلد/آدرس`

لینک‌ها

[متن لینک](https://example.com)

اگر نیاز به نمایش یک لینک "خام" دارید (نادر):

`https://example.com`

لیست‌ها

لیست نقطه‌ای:

- مورد 1
- مورد 2
  - زیرمورد

لیست شماره‌دار:

1. مرحله 1
2. مرحله 2
3. مرحله 3

نقل قول‌ها / یادداشت‌ها

> این یک یادداشت مهم است.
> می‌تواند شامل دو خط باشد.

جداول

قالب حداقل:

| فیلد | مقدار |
|---|---|
| نام | [ ] |
| وضعیت | [ ] |

نکات:

  • سطر جداکننده |---|---| الزامی است.
  • سلول‌های جدول می‌توانند حاوی **پررنگ**، لینک‌ها و کد باشند.

بلوک‌های کد و متن "خام"

بلوک کد:

\```text
خط 1
خط 2
\```

اگر زبان خاصی است (مثلاً JSON)، می‌توانید آن را مشخص کنید:

\```json
{ "key": "value" }
\```

تصاویر

اگر URL مستقیم تصویر را دارید:

![توضیحات](https://example.com/image.png)

اگر فایل در ویکی آپلود شده است، از لینک/کد تعبیه‌ای که ویکی هنگام آپلود ارائه می‌دهد استفاده کنید.

شکستگی خطوط و پاراگراف‌ها

  • یک پاراگراف جدید با یک خط خالی بین پاراگراف‌ها ایجاد می‌شود.
  • اگر نیاز به شکستگی خط در داخل یک پاراگراف دارید، در انتهای خط دو فاصله (space) اضافه کنید:
خط اول.  
خط دوم.

HTML تعبیه‌شده (با احتیاط استفاده کنید)

بلوک "جزئیات" (Details) جمع‌شونده

از آن برای جزئیات/شواهد طولانی استفاده کنید تا از شلوغ شدن "صفحه اول" جلوگیری شود.

<details>
<summary><b>جزئیات</b></summary>

می‌توانید متن، لیست‌ها و جداول را در اینجا قرار دهید.

</details>

لنگرها (Anchors) و لینک‌های سریع در یک صفحه

لنگر:

<a id="ai-thesis-fit"></a>

لینک به لنگر:

[پرش به تناسب با پایان‌نامه هوش مصنوعی](#ai-thesis-fit)

متغیرهای جایگزین (Placeholders) در قالب‌ها

در قالب‌ها ما از این موارد استفاده می‌کنیم:

  • [ ] — "پر کنید"
  • / — "— / قابل اجرا نیست" (زمانی که معنی‌دار باشد)
  • YYYY‑MM‑DD — قالب تاریخ
  • Tier‑1/2/3 — سطح منبع (شواهد/زمینه/نویز)

اشتباهات رایج

  • مخلوط کردن جعبه اطلاعات (infobox) و توضیحات: جعبه اطلاعات فقط برای حقایق کوتاه است؛ توضیحات در بدنه صفحه قرار می‌گیرند.
  • نوشتن بدون منبع در جایی که باید منبعی وجود داشته باشد.
  • شلوغ کردن "صفحه اول": جزئیات طولانی بهتر است در داخل <details> قرار گیرند.
  • استفاده از "زبان مالی" (توصیه‌های خرید/فروش/نگهداری، پیش‌بینی‌ها) — این برای ما ممنوع است؛ ما حقایق/خطرات/مواردی که باید بررسی شوند را می‌نویسیم.

مینی چک‌لیست قبل از انتشار

  • آیا 1-2 خط وجود دارد که توضیح دهد "این چیست"؟
  • آیا لینک‌هایی به منابع اولیه وجود دارد؟
  • آیا فیلدهای خالی و "نامشخص" در جدول وجود دارد (هر کدام باید یا یک مقدار باشد یا —/—
  • آیا Last verified (آخرین بررسی) پر شده است؟