https://github.com/ezralazuardy/aksara

ꦲ Headless javanese script translator.
https://github.com/ezralazuardy/aksara

aksara javanese translator

Last synced: 3 months ago
JSON representation

ꦲ Headless javanese script translator.

• Host: GitHub
• URL: https://github.com/ezralazuardy/aksara
• Owner: ezralazuardy
• License: mit
• Created: 2024-06-04T01:42:51.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-04T05:55:25.000Z (8 months ago)
• Last Synced: 2024-10-06T01:01:48.675Z (3 months ago)
• Topics: aksara, javanese, translator
• Language: TypeScript
• Homepage: https://aksara-demo.lazuardy.tech
• Size: 129 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

  

  

  

  

  



## ꦲ aksara






  

  


    

      There were (two) emissaries. They began to fight.


      Their valor was equal. They both fell dead.

    

  





```typescript

translate("hana caraka"); // ꦲꦤ ꦕꦫꦏ

```

Aksara is a simple package that helps you to translate your text into Javanese Script or also known as _Aksara Jawa_, which is one of the most beautiful scripts in the world. You can translate a latin text into Javanese Script or vice-versa in just one line of code.

The translated text will be formatted as [Unicode](https://home.unicode.org) string of Javanese Script characters that can be used in any text editor or web browser, without any specific font requirement.

It's also typescript compatible, so you can use it in any javascript or typescript project.

> Demo App: https://aksara-demo.lazuardy.tech

> Reference: [Wikipedia](https://en.wikipedia.org/wiki/Javanese_script), [Matador Network](https://matadornetwork.com/read/5-beautiful-endangered-alphabets)




### 🚀 Getting Started

It's only require 2 simple steps to get started.

Install the package

```bash

npm install @ezralazuardy/aksara

```

And use it!

```typescript

import { translate } from "@ezralazuardy/aksara";

const result = translate("hana caraka"); // ꦲꦤ ꦕꦫꦏ

```

For advanced usage, please read the [documentation](#-documentation) below.




### 🔄 Revert Translation

If you want to revert the translation, you can just use the `translate` function again.

```typescript

import { translate } from "@ezralazuardy/aksara";

const result = translate("ꦲꦤ ꦕꦫꦏ"); // hana caraka

```

No need to use other function. Simple, right?




### 📖 Documentation

A proper documentation is still in progress 🥲

> Written in [Typescript](https://www.typescriptlang.org). Heavily inspired by [@bennylin](https://github.com/bennylin).