همونطور که بیشتر وب‌سایت‌های که مربوط به برنامه‌نویس‌ها هستن مثل Github برای نوشتن داکیومنت‌هاشون Markdown رو انتخاب کردن ما هم در کدبای‌می همین رویه رو پیش گرفتم.

در مطلب پیش رو روش‌هایی که میتونید مطالبتون رو فرمت کنید براتون بیان میکنم.

عنوان‌ها

1# عنوان ۱
2## عنوان ۲
3### عنوان ۳
4#### عنوان ۴
5##### عنوان ۵
6###### عنوان ۶
7
8برای عنوان ۱ و ۲ میتونید از حالت جایگزین زیر هم استفاده کنید:
9
10عنوان ۱
11======
12
13عنوان ۲
14------

عنوان ۱

عنوان ۲

عنوان ۳

عنوان ۴

عنوان ۵

عنوان ۶

برای عنوان ۱ و ۲ میتونید از حالت جایگزین زیر هم استفاده کنید:

عنوان ۱

عنوان ۲

تاکید‌ها (Emphasis)

1ایرانیک یا ایتالیک با استفاده از *ستاره* یا _underscore_.
2
3بولد کردن با استفاده از **ستاره‌ها** یا __underscores__.
4
5ترکیب بولد و ایرانیک **asterisks and _underscores_**
6
7خط زدن با استفاده از علامت تیلدا ~~Scratch this.~~

ایرانیک یا ایتالیک با استفاده از ستاره یا underscore.

بولد کردن با استفاده از ستاره‌ها یا underscores.

ترکیب بولد و ایرانیک asterisks and underscores.

خط زدن با استفاده از علامت تیلدا Scratch this.

لیست‌ها

11. اولین آیتم لیست ترتیب‌دار
22. آیتمی دیگر
3..* زیر لیست بدون ترتیب آیتم ۲
41. اعداد چندان مهم نیستن، فقط اینکه عدد باشه کافیه
5..1. زیر لیست مرتب
64. آیتمی دیگر
7  
8   شما میتونید عمق مطلب رو هم توی آیتم‌‌های یک لیست تعیین کنید. 
9   با استفاده از فاصله(space) میتونید بین خطوط فاصله ایجاد کنید یا عمق بدید.
10  
11* لیست بدون ترتیب با استفاده از ستاره
12- یا با استفاده از علامت منفی
13+ یا با استفاده از علامت مثبت

1. اولین آیتم لیست ترتیب‌دار

2. آیتمی دیگر ..* زیر لیست بدون ترتیب آیتم ۲

3. اعداد چندان مهم نیستن، فقط اینکه عدد باشه کافیه ..1. زیر لیست مرتب

4. آیتمی دیگر

   شما میتونید عمق مطلب رو هم توی آیتم‌‌های یک لیست تعیین کنید. با استفاده از فاصله(space) میتونید بین خطوط فاصله ایجاد کنید یا عمق بدید.

• لیست بدون ترتیب با استفاده از ستاره

• یا با استفاده از علامت منفی

• یا با استفاده از علامت مثبت

لینک‌ها

دو راه برای ایجاد لیست‌ها موجود هست.

1[I'm an inline-style link](https://codebyme.com)
2
3[I'm an inline-style link with title](https://codebyme.com "CodeByMe's Homepage")
4
5[I'm a reference-style link][Arbitrary case-insensitive reference text]
6

I'm an inline-style link

I'm an inline-style link with title

[I'm a reference-style link][Arbitrary case-insensitive reference text]

یا اینکه خود لینک رو بذارید یا داخل [] قرارش بدید [link text itself].

1URLs and URLs in angle brackets will automatically get turned into links.
2http://www.example.com or <http://www.example.com> and sometimes
3example.com (but not on Github, for example).

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).

تصاویر

1این لوگوی ماست (روی عکس برید تا عنوان رو هم ببینید):
2
3استایل بین خطی (inline): 
4![alt text](https://codebyme.com/images/logo.png "Logo Title Text 1")
5
6استایل رفرنسی : 
7![alt text][logo]
8
9[logo]: https://codebyme.com/images/logo.png "Logo Title Text 2"

این لوگوی ماست (روی عکس برید تا عنوان رو هم ببینید):

استایل بین خطی (inline):

استایل رفرنسی :

هایلات کردن کد‌ها و نشانه‌گذاری‌ها

`کد` درون خطی یدونه `بک تیک` اطرافش داره.

کد درون خطی یدونه بک تیک اطرافش داره.

برای اینکه کدهاتون رو توی یه بلوک هایلایت کنید باید از ‍‍``` استفاده کنید و جلوش اسم زبان رو بنویسد و کدتون رو خط بعدیش بذارید و در نهایت با همین ``` اون قسمت کدتون رو ببندید.

1
2\`\`\`javascript
3var s = "JavaScript syntax highlighting";
4alert(s);
5\`\`\`
6 
7\`\`\`python
8s = "Python syntax highlighting"
9print s
10\`\`\`
11 
12\`\`\`
13No language indicated, so no syntax highlighting.
14But let's throw in a <b>tag</b>.
15\`\`\`
16

البته تو اینجا ما برای نمایش از \ استفاده کردیم و شما باید پاکش کنید و همون بک تیک رو بذارید تا استایل زیر رو داشته باشید.

1var s = "JavaScript syntax highlighting";
2alert(s);

1s = "Python syntax highlighting"
2print s

1زبانی مشخص نشده برای همین کدها رنگی نمیشن
2برای مثل یه تگ بذاریم <b>tag</b>.

جدول‌ها

از علامت کلون(:) برای مرتب سازی ستون جدول‌ها میتونید استفاده کنید

حداقل باید سه علامت دش (-) برای جداسازی هر خونه جدول توی هدر استفاده بشه. ‍‍‍

1| Tables        | Are           | Cool  |
2| ------------- |:-------------:| -----:|
3| col 3 is      | right-aligned | $1600 |
4| col 2 is      | centered      |   $12 |
5| zebra stripes | are neat      |    $1 |
6
7
8Markdown | Less | Pretty
9--- | --- | ---
10*Still* | `renders` | **nicely**
111 | 2 | 3

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

Markdown	Less	Pretty
Still	renders	nicely
1	2	3

نقل قول های بلوکی (Blockquotes)

1> نقل قول‌های بلوکی خیلی کاربردی هستن
2> این خط هم قسمتی از نقل قول قبلی هستش
3
4جداسازی نقل قول‌ها
5
6> این یه نقل قول خیلی خیلی خیلی بلنده. نمیدونم چقد دیگه باید بنویسم تا بهتون نشونش بدم. برای ادامه به یه چند جمله از لورم ایپسوم اکتفا میکنم. لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است چاپگرها و متون بلکه روزنامه و مجله در ستون و سطرآنچنان که لازم است و برای شرایط فعلی تکنولوژی مورد نیاز و کاربردهای متنوع با هدف بهبود ابزارهای کاربردی می باشد

نقل قول‌های بلوکی خیلی کاربردی هستن این خط هم قسمتی از نقل قول قبلی هستش

جداسازی نقل قول‌ها

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

منابع

• https://github.github.com/gfm/

این مطلب رو به مرور زمان بیشتر آپدیتش میکنم و اطلاعات بیشتری در اختیارتون قرار میدم.