Skip to content

learlab/itell-turndown

Repository files navigation

iTELL Turndown

This is an HTML to Markdown converter for iTELL. It is based on htmd and turndown.

Usage

  1. yarn to install dependencies.
  2. yarn build to build the project. This will generate an itell-turndown.[darwin|win32|linux].node file in the project root.
  3. yarn test to run tests with ava.

Optionally, run benchmarks with yarn bench.

Development requirements

  • Install the latest Rust with rustup
  • Install Node.js
  • Install yarn

TODO: Release Package Instructions

Ensure you have set your NPM_TOKEN in the GitHub project setting.

In Settings -> Secrets, add NPM_TOKEN into it.

When you want to release the package:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]

git push

GitHub actions will do the rest job for you.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published