Skip to content

mohessaid/poem-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Poem.js

This project was originaly a script written by @hamzamez to render Arabic poems correctly in the dom.

What does this project do?

Provide a lightweight JS library to handle Arabic poems and render them in their Vertical style.

Why is this project useful?

Believe me! Writing Arabic poems inside your web pages, mobile apps is indeed a frustrating job. Then you have to style it properly to give your readers or users a full experience as they used to with books. This process is very annoying espicially for webmasters who have little experience with HTML or CSS.

A sample of what Poem.js can do

How to use it

It is very simple. You put the poem inside a table, and every half-verse in a inside a cell. like so. and include the script in your page as it is. You can see an example in this link : https://codepen.io/mohessaid/pen/dwZZYm

<h1>ุงู„ู‚ุตูŠุฏุฉ ุงู„ุนู…ุฑูŠุฉ</h1>
  <table cellspacing="20" class="poem" dir="rtl">
    <tbody>
      <tr>
        <td><span>ุฅู†ู€ู€ู‰ ุชู€ุฐูƒู€ุฑุชู ู€ ูˆุงู„ุฐูƒู€ุฑู‰ ู…ูู€ุคูŽุฑู‘ูู‚ู€ุฉูŒ</span></td>
        <td><span>ู…ู€ู€ุฌุฏุงู‹ ุชู€ู€ู„ูŠู€ู€ุฏุง ุจู€ู€ุฃูŠู€ู€ุฏูŠู€ู€ู†ู€ุง ุฃุถู€ุนู†ุงู‡</span></td>
      </tr>
      <tr>
        <td><span>ูˆูŠู€ุญูŽ ุงู„ุนู€ุฑูˆุจุฉ ! ูƒุงู† ุงู„ูƒูˆู†ู ู…ุณุฑุญู‡ุง </span></td>
        <td><span>ูู€ู€ุฃุตู€ู€ุจูŽุญู€ู€ุช ุชู€ู€ุชูˆุงุฑู‰ ูู€ู€ูŠ ุฒูˆุงูŠู€ุงู‡</span></td>
      </tr>
      <tr>
        <td><span>ุฃู†ู‘ูŽู‰ ุงุชู€ู€ุฌู‡ู€ู€ุช ุฅู„ู‰ ุงู„ุฅุณู€ู„ุงู… ูู€ูŠ ุจู€ู„ุฏ</span></td>
        <td><span>ุชู€ุฌุฏู’ู‡ู ู€ ูƒู€ุงู„ุทู€ูŠุฑ ู€ ู…ู€ู‚ุตู€ูˆุตุงู‹ ุฌู†ุงุญุงู‡</span></td>
      </tr>
      <tr>
        <td><span>ูƒู€ู€ู… ุตู€ู€ุฑููŽู€ู€ุชู’ู†ูŽู€ู€ุง ูŠู€ู€ุฏูŒ ูƒู€ู€ู†ู‘ุง ู†ู€ู€ุตุฑู‘ููู€ู€ู‡ุง</span></td>
        <td><span>ูˆุจู€ู€ู€ุงุช ูŠู€ู€ู€ู…ู€ู€ู„ูƒู€ู€ู€ู†ุง ุดู€ู€ู€ุนุจูŒ ู…ู„ูƒู€ู€ู†ุงู‡</span></td>
      </tr>
      <tr>
        <td><span>ู‡ู€ู„ ูƒู€ุงู† ุฏููŠู’ู€ู† ุงุจู€ู†ู ุนู€ุฏู†ุงู†ู ุณูˆู‰ ูู„ู‚</span></td>
        <td><span>ุดู€ู‚ ุงู„ูˆุฌู€ูˆุฏุŒ ูˆู„ูŠู€ู„ู ุงู„ุฌู€ู‡ู„ ูŠู€ุบุดู€ุงู‡ ุŸ</span></td>
      </tr>
      <tr>
        <td><span>ู‡ู€ู€ู€ูŠ ุงู„ุญู€ู€ู€ู†ูŠู€ู€ูุฉู ุนู€ู€ูŠู†ู ุงู„ู„ู€ู‡ ุชู€ู€ูƒู„ุคู‡ู€ู€ุง</span></td>
        <td><span>ูู€ู€ูƒู„ู…ู€ู€ุง ุญู€ู€ุงูˆู„ูˆุง ุชู€ู€ุดูˆูŠู€ู€ู‡ู‡ู€ู€ุง ุดู€ู€ุงู‡ู€ูˆุง</span></td>
      </tr>
    </tbody>
  </table>

How do I get started?

coming . . .

Where can I get more help, if I need it?

coming . . .

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Hamza MEZERREG - Initial work - hamzamez
  • Mohammed Essaid MEZERREG - Renewal & Update - mohessaid

You want to be part of this โ˜๏ธ list ๐Ÿ˜ . All pull requests are welcome as long as they resepect our contributing guidelines.

About

A JavaScipt script to render Arabic poems correctly in webpages.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •