Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zoghal committed Oct 7, 2020
1 parent 0648eb9 commit 77307dc
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
# Virastar (ویراستار)
Virastar is a Persian text cleaner.

A javascript port of [aziz/virastar](https://github.com/aziz/virastar)

[demo online](https://zoghal.github.io/virastar/)

[download offline](https://github.com/zoghal/virastar/releases/)

----

<p dir="auto">ویراستار به شما کمک می‌کند تا متون فارسی زیبا‌تر و درست‌تری بنویسید.</p>
<p dir="auto">ویراستار به طور پیش فرض این کار‌ها را انجام می‌دهد:</p>
<ul dir="auto">
<li>۱. نویسه‌های عربی را به فارسی تبدیل می‌کند. مثلا کاف و یای عربی.</li>
<li>۲. نویسه‌های انگلیسی رایج در تایپ فارسی را به معادل صحیح فارسی آن تبدیل می‌کند، مثلا تبدیل کامای انگلیسی به ویرگول (،)، یا نقطه ویرگول به جای semicolon (؛) و یا استفاده از «گیومه‌های فارسی»</li>
<li>۳. اعداد عربی و انگلیسی و علائم ریاضی را به معادل فارسی آن‌ها تبدیل می‌کند. مثلا: ۱۲٪ ۴۵۶</li>
<li>۴. سه نقطه را به نویسه صحیح آن که تنها یک نویسه است تبدیل کرده و فاصله گذاری آن را اصلاح می‌کند…</li>
<li>۵. در ترکیباتی مانند «خانهٔ پدری» که با «ه» تمام می‌شوند نشانه «ی» کسرهٔ اضافه را به «هٔ» تبدیل می‌کند.</li>
<li>۶. دو علامت منهای پی در پی را به خط کشیده کوتاه (–) و سه علامت منهای پی در پی را به خط کشیده بلند (—) تبدیل می‌کند.</li>
<li>۷. فاصله گذاری را تصحیح می‌کند. بین هر کلمه تنها یک فاصله و بین پیشوندها و پسوندهای مانند «می‌»، «‌تر» و «‌ترین» یک نیم فاصله قرار می‌دهد. بین ویرگول یا نقطه و کلمه قبل آن فاصله را حذف می‌کند.</li>
<li>۸. فاصله گذاری را برای متون بین «گیومه»، {آکولاد}، [کروشه] و (پرانتز) تنظیم می‌کند.</li>
<li>۹. علامت تعحب و سوال اضافی را حذف می‌کند؟!</li>
<li>۱۰. جدید: پشتیبانی از پیشوندها [ام|ات|اش|ای|اید|ایم|اند|هایی|هایم|هایت|هایش|هایمان|هایتان|هایشان] مثل (نمی‌توانم، پی‌ام‌هایت، خانه‌‌ام، خانه‌هایتان، خانه‌‌اید)</li>
<li>۱۱. جدید: پشتیبانی از پسوندهای [بی] مثل (بی‌تفاوتی، بی‌شرافت)</li>
</ul>



[new demo](https://zoghal.github.io/virastar/)

[master demo](http://juvee.github.io/virastar/)



Expand Down Expand Up @@ -158,3 +178,5 @@ _all options are enabled by default._
## License

This software is licensed under the MIT License. [View the license](LICENSE).

A javascript port of [aziz/virastar](https://github.com/aziz/virastar)

0 comments on commit 77307dc

Please sign in to comment.