Node.js で Anki カードを生成する

Node.js 22.13 以降を使います。新しいアプリケーションのディレクトリで実行します。

mkdir anki-deck
cd anki-deck
npm install --include=optional ankiforge@0.3.1

npm の公開パッケージと、環境に一致するネイティブのオプション依存パッケージをインストールします。対応プラットフォームは検証済みの環境を参照してください。

デッキをエクスポートする

次を main.mjs に保存します。

import { Project, Note, BuildOptions } from 'ankiforge';

const project = new Project('spanish').defaultDeck('Spanish');
project.add('es:hola', Note.basic('hola', 'hello'));
const output = await project.build(BuildOptions.to('spanish.apkg'));
console.log(output.artifact.path);
await output.artifact.close();

node main.mjs

永続ファイル spanish.apkg を Anki で開きます。Spanish デッキに hola → hello が含まれています。後で編集する際も、名前空間 spanish とキー es:hola を維持してください。永続成果物を閉じてもファイルはディスクに残ります。エクスポートに Anki のインストールは必要ありません。

TypeScript と次の作業

JSON から Anki を生成するレシピには、TypeScript のコンパイルから実行までの完全な手順があります。

ESM には .mjs、CommonJS には require('ankiforge') を使います。パッケージには TypeScript の型宣言が同梱されています。TypeScript の設定を参照してください。

• 画像と音声と Node のメディア API
• 独自のノートタイプとテンプレートバンドル
• 画像穴埋め
• 比較と更新
• Node API とトラブルシューティング

ソースからのビルドとローカルパッケージの作成は、ソースからのビルドを参照してください。