Package Exports
- weaveit
- weaveit/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (weaveit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
WeaveIt
WeaveIt is a powerful TypeScript SDK that transforms code tutorials into engaging video content β complete with slides, audio narration, and optional AI assistance. Designed for developers, educators, and content creators, WeaveIt automates the process of turning technical explanations into dynamic multimedia tutorials.
With built-in support for:
- π Code snippet analysis
- π§ AI-powered narration via OpenAI
- π£οΈ Text-to-speech voiceovers
- π₯ Slide + video generation using
canvasandffmpeg
You can go from raw .ts files to narrated tutorial videos with just one command.
The SDK is fully configurable β users can provide their own OpenAI API keys, toggle mock/test mode, and customize output formats. Whether you're building an AI-driven learning platform or automating dev tutorials, WeaveIt helps you deliver clean, clear, and compelling educational content.
Great! Since WeaveIt is an SDK, your README should be clear about how developers can integrate and use it. Here are some important sections you should consider adding if theyβre not already there:
π¦ Installation
npm install weaveit
# or
pnpm add weaveitβοΈ Configuration
import { WeaveItConfig } from 'weaveit';
WeaveItConfig.setApiKey('your-api-key-here');π Usage
import { generateVideoTutorial } from 'weaveit';
generateVideoTutorial({
filePath: 'example.ts',
voice: true,
video: true
});