نحوه نوشتن با فرمت Markdown¶
برای نوشتن رایتاپ با فرمت md میتوانید از نرمافزار یادداشتبرداری متن باز Joplin در ویندوز استفاده کنید. این نرمافزار، فرمت md و زبان فارسی را پشتیبانی میکند و نوشتهها در آن از راست به چپ نمایش داده میشوند. پس از دانلود و نصب نرمافزار Joplin, میتوانید جهت سهولت در نوشتن رایتاپهای خود، از این نمونه رایتاپ به عنوان قالبی برای نگارش استفاده کنید. در ادامه این بخش، انواع عناصر نوشتاری Markdown همراه با نمایش آن در سایت در دو تب جداگانه توضیح داده شده که میتوانید از آنها در نوشتههای خود استفاده کنید. استفاده از این عناصر میتواند باعث ارتقا ساختار و خوانایی رایتاپ شما گردد.
حالتهای نوشتاری¶
در این بخش با انواع نوشتار مانند ضخیم کردن یا زاویه دادن به کلمات، ارجاع دادن از طریق لینک و نحوه نقل قول گذاشتن در داخل متن آشنا خواهید شد.
**ضخیم کردن نوشته**
*زاویه دار بودن متن*
قراردادن [لینک](https://flagmotori.github.io/) در متن
> نقل قول به این صورت است
فرمول نویسی¶
۱- فرمول در متن¶
خوشبختانه مارکداون از فرمول نویسی Latex پشتیبانی میکند. بنابراین برای نوشتار ریاضی در داخل متن به این صورت \Sigma[(a^b)+c]* \sqrt d =23 میتوان انجام داد.
خوشبختانه مارکداون از از فرمول نویسی Latex پشتیبانی می کند.
بنابراین برای نوشتار ریاضی در داخل متن به این صورت $\Sigma[(a^b)+c] *\sqrt d =23$ می توان انجام داد.
۲- فرمول نویسی در وسط صفحه¶
$$
m^5 \equiv a2 \times{a1^{-1}} \mod \varphi (n)
$$
انواع یادداشت و نکتهگذاری :¶
در این بخش میتوانید یادداشت ها یا نکات مهم را قرار دهید. لطفا نکات اشاره شده در این قسمت را در رایتاپ خود رعایت کنید.
Info
نکته بسیار مهم : نویسنده باید قوانین مربوط به سرقت ادبی را رعایت کند. درغیر این صورت عواقب آن متوجه خود نویسنده خواهد بود.
یادداشت 1
می توان نام نویسنده را به عنوان یک یادداشت در انتها ذکر کرد.
یادداشت 2
Flag
توصیه می شود که فلگ را داخل این نوع یادداشت گذاری قرار دهید.
!!! info
**نکته بسیار مهم** : نویسنده باید قوانین مربوط به **سرقت ادبی** را رعایت کند. درغیر اینصورت عواقب آن متوجه خود نویسنده خواهد بود.
!!! note "یادداشت 1"
می توان نام نویسنده را به عنوان یک یادداشت در انتها ذکر کرد.
!!! note ""
یادداشت 2
??? success "Flag"
توصیه میشود که فلگ را داخل این نوع یادداشت گذاری قرار دهید.
انواع نمایش کد:¶
دستورات در خط فرمان:¶
> pip install pycryptodome
> import numpy as np
```
> pip install pycryptodome
> import numpy as np
```
قرار دادن مستقیم کد در صفحه:¶
simple.py | |
---|---|
1 2 3 4 5 6 7 8 9 |
|
```python title="simple.py" linenums="1" hl_lines="5 6 7"
import math
for i in range(10):
print(f"سلام دنیا")
p = 2**(i+1)
n = 3*p
print(f"{n = }")
else:
print("Done!")
```
بدون شماره خط و هایلات کردن خطوط
print("Hello world!")
n=1
for i in range(10):
p = 2**(i+1)
n = 3*n
print(n)
```py
print("Hello world!")
n=1
for i in range(10):
p = 2**(i+1)
n = 3*n
print(n)
```
قرار دادن کد برنامه از خارج صفحه¶
توجه داشته باشید که علامت # را از قسمت آدرسدهی در فرمت markdown حذف کنید. ما در اینجا جهت نمایش آدرسدهی آن را قرار دادهایم.
from web3 import Web3
import json
setupContract = "0x1AC90AFd478F30f2D617b3Cb76ee00Dd73A9E4d3"
url = "https://eth-sepolia.g.alchemy.com/v2/SMfUKiFXRNaIsjRSccFuYCq8Q3QJgks8"
provider = Web3(Web3.HTTPProvider(url))
with open("setup.json") as f: #json file with the contract ABI
setup_json = json.load(f)
setup = provider.eth.contract(address=setupContract, abi = setup_json)
print(setup.functions.enterVenue().call())
```py title="main.py"
#--8<-- "docs/getStarted/main.py"
```
نمایش جدول¶
در نوشته خود میتوانید از جدول مانند نمونه زیر استفاده کنید. این سایت برای ساخت جدول به شما کمک میکند. سعی کنید جدول را با تگ center وسطچین کنید.
Right | Left | Default | Center | Method | تاییدیه |
---|---|---|---|---|---|
12 | 12 | 12 | 12 | GET | |
123 | 123 | 123 | 123 | PUT | |
1 | 1 | 1 | 1 | DELETE |
<center>
| Right | Left | Default | Center | Method | تاییدیه |
|------:|:-----|---------|:------:|:-------:|:--------------------:|
| 12 | 12 | 12 | 12 | `GET` | :material-check: |
| 123 | 123 | 123 | 123 | `PUT` | :material-check-all: |
| 1 | 1 | 1 | 1 | `DELETE`| :material-close: |
</center>
نمایش تصاویر¶
تصاویر را نیز مانند جدول در تگ center قرار دهید تا هنگام نمایش وسطچین باشد توجه داشته باشید که فایل تصویر خود را همراه با فایل مارکداون (md.*) ارسال کنید.
استفاده از ایموجی¶
میتوانید با تایپ کردن نام ایموجی بین دو علامت دو نقطه (:EMOJICODE:) ایموجیهای مختلفی را به نوشته خود اضافه کنید. نام این ایموجیها براساس ایموجیهای متن باز توییتر Twemoji است.
:smile:
:triangular_flag_on_post:
:writing_hand:
استفاده از انواع لیست¶
گاهی ممکن است که در نوشته خود نیاز به لیست کردن برخی از نکات یا کارها را داشته باشید. این لیستها ممکن است ترتیبی، غیرترتیبی یا ترکیبی از این دو مدل باشند. در ادامه سه نوع نمایش لیست که توسط فرمت Markdown پشتیبانی میشود را نشان میدهیم.
لیست ترتیبی:¶
- شماره یک
- شماره یک یک
- شماره یک دو
- شماره یک دو یک
- شماره یک دو دو
- شماره دو
- اول
- دوم
1. شماره یک
1. شماره یک یک
2. شماره یک دو
1. شماره یک دو یک
2. شماره یک دو دو
2. شماره دو
- اول
- دوم
لیست غیرترتیبی:¶
-
شماره یک
- شماره یک یک
- شماره یک یک یک
- شماره یک یک
-
شماره دو
- شماره یک
- شماره یک یک
- شماره یک یک یک
- شماره دو
لیست وظایف:¶
- وظیفه یک انجام شده
- وطیفه دو کامل انجام نشده
- وظیفه دو اول
- وظیفه دو دو
- وظیفه سه
- [x] وظیفه یک انجام شده
- [ ] وطیفه دو کامل انجام نشده
* [x] وظیفه دو اول
* [ ] وظیفه دو دو
- [ ] وظیفه سه
این تنها بخشی از ویژگیهای فرمت نوشتاری md بود که در اینجا اشاره شد، اگرچه موارد اشاره شده در اینجا برای نگارش یک رایتاپ کافی است اما میتوانید برای جزئیات بیشتر در مورد این فرمت به این سایت سر بزنید.
نویسنده