yanki 0.3.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yanki",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "An ultra-simple CLI tool and TypeScript library for syncing Markdown to Anki flashcards.",
   "repository": {
@@ -57,6 +57,7 @@
     "chalk": "^5.3.0",
     "globby": "^14.0.1",
     "rehype-mathjax": "^6.0.0",
+    "rehype-parse": "^9.0.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
@@ -65,6 +66,7 @@
     "bumpp": "^9.4.1",
     "deepmerge-ts": "^7.0.3",
     "filenamify": "^6.0.0",
+    "hast-util-to-text": "^4.0.2",
     "nanoid": "^5.0.7",
     "path-browserify-esm": "^1.0.4",
     "pkgroll": "^2.1.1",
@@ -83,7 +85,6 @@
     "remark-remove-comments": "^1.0.1",
     "remark-wiki-link": "^2.0.1",
     "sort-keys": "^5.0.0",
-    "string-strip-html": "^13.4.8",
     "tsx": "^4.15.4",
     "type-fest": "^4.20.0",
     "typescript": "^5.4.5",

package/readme.md

@@ -131,7 +131,7 @@ Yanki uses Anki's built-in CSS stylesheet to style cards by default, but it make
 
 The "one Markdown file = one Anki note" can make for a lot of individual files, and thinking up and renaming files as content is revised can be tedious. So, if you want, Yanki can manage the names of your note files based on their content.
 
-Yanki looks inside each note, and extracts either the text of the prompt (e.g. the front of the card in most cases), or the "response" (e.g. the back of the card in most cases) to use as the filename. Truncation, deduplication, and sanitization are all taken care of.
+Yanki looks inside each note, and extracts either the text of the "prompt" (e.g. the front of the card in most cases), or the "response" (e.g. the back of the card in most cases) to use as the filename. Truncation, deduplication, and sanitization are all taken care of.
 
 Edge cases are carefully managed to ensure that there's always _some kind_ of best-effort semantically valuable file name assigned.
 
@@ -215,7 +215,18 @@ Clozing a block element is not currently supported.
 
 The `yanki` CLI tool requires Node 18+. The exported TypeScript / JavaScript APIs are isomorphic, and can run in both browser-based and Node runtime environments. The Yanki library is ESM-only, is implemented in TypeScript, and bundles a complete set of type definitions.
 
-The [Anki](https://apps.ankiweb.net) desktop app with the [Anki-Connect](https://foosoft.net/projects/anki-connect/) add-on installed and configured is also required to do anything useful with the library.
+#### Prerequisites:
+
+- The [Anki desktop app](https://apps.ankiweb.net)
+- The [Anki-Connect](https://foosoft.net/projects/anki-connect/) add-on
+
+  If you need to install it, select _Tools → Add-ons_ from the menu, click _Get Add-ons..._, and then enter the code `2055492159` in the field to get Anki-Connect.
+
+  Anki-Connect may ask for your permission in the Anki application to connect to Obsidian on the first sync.
+
+  If the automatic permission request fails, you might need to configure Anki-Connect to accept connections from your origin.
+
+  In Anki, select _Tools → Add-ons_ from the menu, then select _AnkiConnect_ from the list, and click the _Config_ button in the lower right. In the ensuing modal, add the host and port from which you're attempting to connect to to the `webCorsOriginList` array.
 
 ### Installation
 
@@ -496,9 +507,9 @@ The Yanki TypeScript / JavaScript library is idempotent, so you can run it in a
 
 There's one exception, the `syncFiles(...)` function, which by default relies on file system access to work.
 
-To retain `syncFiles(...)`'s utility in a browser environment, has the optional arguments `readFile` and `writeFile`, which are implemented by `node:fs/promises` by default in Node environments.
+To retain `syncFiles(...)`'s utility in a browser environment, has the optional arguments `readFile`, `writeFile`, and `rename`, which are implemented by `node:fs/promises` by default in Node environments.
 
-Running Yanki in a browser environment required implementing and passing `readFile` and `writeFile` implementations to `syncFiles(...)` that are suited to your particular use case. (A warning will be provided if you neglect to do so.)
+Running Yanki in a browser environment requires implementing and passing `readFile`, `writeFile`, and `rename` implementations to `syncFiles(...)` that are suited to your particular use case. (A warning will be provided if you neglect to do so.)
 
 The rest of the library should work fine in both contexts without special measures.