GithubHelp home page GithubHelp logo

chinese-worksheet-generator's Introduction

Chinese Character Worksheet Generator

A simple command-line utitlity to generate Hanzi Worksheets. Optimized for the Supernote with Top-bar or Right-bar.

Example Sheet

Reqirements

  • NodeJS > v16

Install

yarn install or npm install

Run

node ./index.js [...options]

Options

-f, --filename

Where to save the generated file.

Default: test.pdf

-c, --characters

A string containing the characters to include in the worksheet. Each character will be split into a separate line. The script will strip any non-characters from your input.

Default: 的一是不了人我在有他这为之大来以个中上们

-s, --size

The paper size to use. Currently supports A5 and A6.

Default: A6

-hh, --hint

Include hint line that shows the stroke order. Will be disabled if --tracing is enabled.

Default: false

Hint Example

-t, --tracing

Include tracing hints on the grid.

Default: false

Tracing Example

Dependencies

No need to install these separately, just for convenience if you want to edit the code.

Future Features

  • Support more page sizes
  • Option to add more practice lines
  • Color options
  • Option to display pinyin
  • Option to display translation

chinese-worksheet-generator's People

Contributors

dsystems-io avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.