https://github.com/wcoder/typesetter.js

Simple and extensible typesetter with JavaScript
https://github.com/wcoder/typesetter.js

javascript pure-javascript typesetter typesetting typing typing-skills typing-trainer typing-tutor typingspeedtest

Last synced: 17 days ago
JSON representation

Simple and extensible typesetter with JavaScript

• Host: GitHub
• URL: https://github.com/wcoder/typesetter.js
• Owner: wcoder
• License: apache-2.0
• Created: 2015-06-16T18:00:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-12T21:29:33.000Z (5 months ago)
• Last Synced: 2024-10-09T08:43:25.375Z (about 1 month ago)
• Topics: javascript, pure-javascript, typesetter, typesetting, typing, typing-skills, typing-trainer, typing-tutor, typingspeedtest
• Language: JavaScript
• Homepage: https://wcoder.github.io/typesetter.js/
• Size: 390 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typesetter.js

Simple and extensible typesetter.

[Demo](https://wcoder.github.io/typesetter.js/index.html)

## Install

```

npm i typesetter.js

```

## Features

- Realistic Key Processing Engine

- Self-contained: Requires zero dependencies to work

- Detecting typos

### Options:

Name | Type | Description

-----|------|-------------

data | string | text content for display

maxErrorsCount | int | limit errors (disable: 0)

cursorAutoShift | bool | skip whitespaces

skipComments | bool | skip comments for `cursorAutoShift`

skipEmptyLines | bool | skip empty lines for `cursorAutoShift`

#### Example

```js

typesetter(element, {

    data: "function hashKey(obj) { return 1; }",

    maxErrorsCount: 5,

    cursorAutoShift: true,   // ignore whitespace

    skipComments: true,      // additional setup for cursorAutoShift

});

```

Developed just for fun. Inspired by the idea of https://typing.io/

---

© 2015 Yauheni Pakala | Apache License 2.0