# clozecraft

> A customizable and flexible flashcard generation solution, specifically designed for Cloze Deletions in spaced repetition platforms. Tailor visually appealing study notes with personalized formatting options such as Markdown bold, highligh, and more

Latest version **0.4.0** (published 2024-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install clozecraft
pnpm add clozecraft
yarn add clozecraft
bun add clozecraft
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2024-04-10 |
| First published | 2024-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 44.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Ocimar Santos |
| Maintainers | ocimar |
| Keywords | cloze, deletion, flashcards, spaced-repetition |

## Links

- npm: https://www.npmjs.com/package/clozecraft
- Repository: https://github.com/MotaOcimar/clozecraft
- Homepage: https://github.com/MotaOcimar/clozecraft#readme
- Issues: https://github.com/MotaOcimar/clozecraft/issues
- npm.io page: https://npm.io/package/clozecraft

## Recent versions

- 0.4.0 (latest) — 2024-04-10
- 0.3.0 — 2024-04-10
- 0.2.0 — 2024-03-29
- 0.1.0 — 2024-03-25
- 0.0.1 — 2024-03-25

## README

# ClozeCraft

ClozeCraft is a library for creating cloze deletion flashcards from text. It seeks to be a simple, easy to use, and flexible tool for creating flashcards from text.

## Usage Example

```typescript
import { ClozeCrafter } from "clozecraft";

const clozeCrafter = new ClozeCrafter( ['{{[c123::]answer[::hint]}}'] );
const clozeNote = clozeCrafter.createClozeNote('People from {{c1::Brazil::country}} are called {{c2::Brazilians::nationality}}.');

console.log(clozeNote?.getCardFront(0)); // People from [country] are called Brazilians.
console.log(clozeNote?.getCardBack(0)); // People from Brazil are called Brazilians.
console.log(clozeNote?.getCardFront(1)); // People from Brazil are called [nationality].
console.log(clozeNote?.getCardBack(1)); // People from Brazil are called Brazilians.
```

---
_Source: https://npm.io/package/clozecraft · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._