handwritten.js - GitLite

KO | EN

gitlite — search

#react #ai #typescript #llm #machine-learning #rust #deep-learning #linux #docker #kubernetes #vue #security #ios #mcp

handwritten.js

(★ 1,952)

Convert typed text to realistic handwriting!

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- - publish.yml
- commit-msg
- pre-commit
- blobstream.js
- download.png
- favicon.ico
- gh-logo.svg
- github-2.png
- handwritten.js
- index.html
- main.js
- reset.css
- style.css
- worker.js
- lorem-ipsum.jpeg
- - index.js
- bin.js
- dataset.json
- index.js
- test.js
.all-contributorsrc
.eslintignore
.eslintrc.json
.gitignore
.npmignore
CODE_OF_CONDUCT.md
commitlint.config.js
CONTRIBUTING.md
LICENSE
package-lock.json
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/alias-rahil/handwritten.js

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd handwritten.js

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install handwritten.js

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn add handwritten.js

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm install handwritten.js -g

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn global add handwritten.js

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">✍️ HANDWRITTEN.js</h1>
<h2 align="center">Convert typed text to realistic handwriting</h2>

[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](https://raw.githubusercontent.com/alias-rahil/handwritten.js/master/)

[![Version](https://img.shields.io/npm/v/handwritten.js.svg)](https://www.npmjs.com/package/handwritten.js)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/alias-rahil/handwritten.js/blob/master/LICENSE)

## Demo

🌐 [handwritten.js](https://alias-rahil.github.io/handwritten.js/)

## Installation

### For browsers:

```html
<script src="https://cdn.jsdelivr.net/gh/alias-rahil/handwritten.js@HEAD/docs/handwritten.js"></script>
```

> This will expose the latest version of `handwritten.js` as a global variable called `handwritten` which you can start using right away. Check the contents of [docs/](https://github.com/alias-rahil/handwritten.js/blob/master/docs/) folder for a simple implementation. For other versions, install the required version with npm and use [browserify](https://www.npmjs.com/package/browserify) to compile it. Optionally, use [babel-minify](https://www.npmjs.com/package/babel-minify) to compress the bundled javascript file.

### For nodejs projects:

```bash
npm install handwritten.js
```

or

```bash
yarn add handwritten.js
```

### Install globally:

```bash
npm install handwritten.js -g
```

or

```bash
yarn global add handwritten.js
```

> Note: **DO NOT** use sudo to install global packages! The correct way is to tell npm where to install its global packages: `npm config set prefix ~/.local`. Make sure `~/.local/bin` is added to `PATH`.

## Usage

### For nodejs projects:

```javascript
const handwritten = require('handwritten.js')
const fs = require('fs')
const rawtext = "Hello, world!"
handwritten(rawtext).then((converted) => {
    converted.pipe(fs.createWriteStream('output.pdf'))
})
```

### CLI usage with npx:

```bash
npx handwritten.js -f "path/to/inputfile.txt" -o "path/to/outputfile.pdf"
```

> Note: Use this method only if you plan to use handwritten.js for one time, installing handwritten.js globally (see-below) is recommended for multiple time usages.

### CLI usage after installing globally:

```bash
handwritten.js -f "path/to/inputfile.txt" -o "path/to/outputfile.pdf"
```

## API

### Command line

```bash
handwritten.js -f path/to/inputfile.txt -o path/to/outputfile.pdf
handwritten.js -f path/to/inputfile.txt -o path/to/outputfile.pdf --ruled
handwritten.js -f path/to/inputfile.txt -o path/to/outputfolder --images png
```

Check `--help` or `--version` option for more details.

### In code

```javascript
handwritten(rawtext)
handwritten(rawtext, { ruled: true })
handwritten(rawtext, { outputType: "jpeg/buf" })
handwritten(rawtext, { ruled: true, outputType: "jpeg/b64" })
handwritten(rawtext, { ruled: true, outputType: "jpeg/b64" , inkColor: COLORS.RED})
```

Default outputType: "pdf". Supported output types are: `pdf`, `jpeg/buf`, `jpeg/b64`, `png/buf` and `png/b64`. If the output type is set to `pdf`, it returns a promise that will resolve in a [pdfkit](https://github.com/foliojs/pdfkit#readme) document instance. Else it will return a promise that will resolve in an array containing the buffer or base64 value of the images according to the output type provided. 
Default `inkColor` is `black`, more ink colors are available through `COLORS` under `handwritten.js/constants`

## Screenshot

<p align="center">
  <img align="center" src="https://raw.githubusercontent.com/alias-rahil/handwritten.js/master/screenshots/lorem-ipsum.jpeg" alt="lorem-ipsum.jpeg">
</p>

## Author

👤 **Rahil Kabani <rahil.kabani.4@gmail.com>**

## Show your support

Give a ⭐️ if this project helped you!

## 🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/alias-rahil/handwritten.js/issues).

> handwritten.js only supports English letters. I am not planning to add support for other languages for now. Please do not any more make issues about this. However, I will merge pull requests if any. See the issue [#18](https://github.com/alias-rahil/handwritten.js/issues/18) for more details.

## Credits

[GDGVIT/HandWriter](https://github.com/GDGVIT/HandWriter) - For the cleaned dataset.

## Handwritten.JS

🏠 [Homepage](https://github.com/alias-rahil/handwritten.js#readme)

## License

[MIT](https://github.com/alias-rahil/handwritten.js/blob/master/LICENSE)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
  <tr>
    <td align="center"><a href="https://alias-rahil.github.io/"><img src="https://avatars2.githubusercontent.com/u/59060219?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rahil Kabani</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=alias-rahil" title="Code">💻</a> <a href="https://github.com/alias-rahil/handwritten.js/commits?author=alias-rahil" title="Documentation">📖</a> <a href="#maintenance-alias-rahil" title="Maintenance">🚧</a></td>
    <td align="center"><a href="http://anthonyng.me"><img src="https://avatars1.githubusercontent.com/u/14035529?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anthony Ng</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=newyork-anthonyng" title="Documentation">📖</a></td>
    <td align="center"><a href="http://modernjsbyexample.net"><img src="https://avatars0.githubusercontent.com/u/7918387?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Junya</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=MrBenJ" title="Code">💻</a> <a href="https://github.com/alias-rahil/handwritten.js/commits?author=MrBenJ" title="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/hsrambo07"><img src="https://avatars0.githubusercontent.com/u/60664245?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Harsh SInghal</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=hsrambo07" title="Code">💻</a> <a href="#maintenance-hsrambo07" title="Maintenance">🚧</a></td>
    <td align="center"><a href="https://github.com/etnnth"><img src="https://avatars3.githubusercontent.com/u/46907310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>etienne</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=etnnth" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/ashikka"><img src="https://avatars.githubusercontent.com/u/58368421?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ashikka Gupta</b></sub></a><br /><a href="#maintenance-ashikka" title="Maintenance">🚧</a> <a href="https://github.com/alias-rahil/handwritten.js/commits?author=ashikka" title="Code">💻</a></td>
    <td align="center"><a href="https://suyashsonawane.me"><img src="https://avatars.githubusercontent.com/u/35629339?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Suyash Sonawane</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=SuyashSonawane" title="Documentation">📖</a> <a href="https://github.com/alias-rahil/handwritten.js/commits?author=SuyashSonawane" title="Code">💻</a></td>
  </tr>
  <tr>
    <td align="center"><a href="https://github.com/Vishal-sys-code"><img src="https://avatars.githubusercontent.com/u/68536727?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vishal Pandey</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=Vishal-sys-code" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/AnirudhBot"><img src="https://avatars.githubusercontent.com/u/78658727?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anirudh Sharma</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/commits?author=AnirudhBot" title="Code">💻</a></td>
    <td align="center"><a href="https://www.newtonmunene.dev/"><img src="https://avatars.githubusercontent.com/u/29271333?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Newton Munene</b></sub></a><br /><a href="https://github.com/alias-rahil/handwritten.js/issues?q=author%3Anewtonmunene99" title="Bug reports">🐛</a> <a href="https://github.com/alias-rahil/handwritten.js/commits?author=newtonmunene99" title="Code">💻</a></td>
  </tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!