hongdown 0.2.0-dev.65 → 0.2.0-dev.67

package/README.md

@@ -3,10 +3,11 @@ Hongdown
 
 [![crates.io][crates.io badge]][crates.io]
 [![npm][npm badge]][npm]
+[![@hongdown/wasm][@hongdown/wasm badge]][@hongdown/wasm]
 [![GitHub Actions][GitHub Actions badge]][GitHub Actions]
 
 Hongdown is a Markdown formatter that enforces [Hong Minhee's Markdown
-style](./STYLE.md) conventions.  The formatter is implemented in Rust using
+style conventions](./STYLE.md).  The formatter is implemented in Rust using
 the [Comrak] library for parsing.  It produces consistently formatted Markdown
 output following a distinctive style used across multiple projects including
 [Fedify], [LogTape], and [Optique].
@@ -15,6 +16,8 @@ output following a distinctive style used across multiple projects including
 [crates.io]: https://crates.io/crates/hongdown
 [npm badge]: https://img.shields.io/npm/v/hongdown?logo=npm
 [npm]: https://www.npmjs.com/package/hongdown
+[@hongdown/wasm badge]: https://img.shields.io/npm/v/@hongdown/wasm?logo=webassembly&label=%40hongdown%2Fwasm
+[@hongdown/wasm]: https://www.npmjs.com/package/@hongdown/wasm
 [GitHub Actions badge]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml/badge.svg
 [GitHub Actions]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml
 [Comrak]: https://comrak.ee/
@@ -277,9 +280,37 @@ See *[STYLE.md](./STYLE.md)* for the complete style specification, including
 the philosophy behind these conventions and detailed formatting rules.
 
 
+Editor integrations
+-------------------
+
+### Zed
+
+Add the following to your Zed settings to use Hongdown as the Markdown
+formatter (contributed by [Lee Dogeon][moreal zed]):
+
+~~~~ json
+{
+  "languages": {
+    "Markdown": {
+      "formatter": {
+        "external": {
+          "command": "hongdown",
+          "arguments": ["-"]
+        }
+      }
+    }
+  }
+}
+~~~~
+
+[moreal zed]: https://hackers.pub/@moreal/019bb141-dc94-7103-ab3d-779941125430
+
+
 Library usage
 -------------
 
+### Rust
+
 Hongdown can also be used as a Rust library:
 
 ~~~~ rust
@@ -291,6 +322,43 @@ let output = format(input, &options).unwrap();
 println!("{}", output);
 ~~~~
 
+### JavaScript/TypeScript
+
+Hongdown is available as a WebAssembly-based library for JavaScript and
+TypeScript:
+
+~~~~ bash
+npm install @hongdown/wasm
+~~~~
+
+~~~~ typescript
+import { format, formatWithWarnings } from "@hongdown/wasm";
+
+// Basic usage
+const markdown = "# Hello\nWorld";
+const formatted = await format(markdown);
+
+// With options
+const result = await format(markdown, {
+  lineWidth: 100,
+  setextH1: false,
+  fenceChar: "`",
+});
+
+// Get warnings along with formatted output
+const { output, warnings } = await formatWithWarnings(markdown);
+if (warnings.length > 0) {
+  for (const warning of warnings) {
+    console.warn(`Line ${warning.line}: ${warning.message}`);
+  }
+}
+~~~~
+
+The library works in Node.js, Bun, Deno, and web browsers.  See the
+[TypeScript type definitions] for all available options.
+
+[TypeScript type definitions]: ./npm/wasm/src/types.ts
+
 
 Development
 -----------

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hongdown",
-    "version": "0.2.0-dev.65+7ac05d11",
+    "version": "0.2.0-dev.67+1efd4bb7",
     "type": "module",
     "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
     "license": "GPL-3.0-or-later",
@@ -27,11 +27,11 @@
         "node": "\u003e=18"
     },
     "optionalDependencies": {
-        "@hongdown/darwin-arm64": "0.2.0-dev.65+7ac05d11",
-        "@hongdown/darwin-x64": "0.2.0-dev.65+7ac05d11",
-        "@hongdown/linux-arm64": "0.2.0-dev.65+7ac05d11",
-        "@hongdown/linux-x64": "0.2.0-dev.65+7ac05d11",
-        "@hongdown/win32-arm64": "0.2.0-dev.65+7ac05d11",
-        "@hongdown/win32-x64": "0.2.0-dev.65+7ac05d11"
+        "@hongdown/darwin-arm64": "0.2.0-dev.67+1efd4bb7",
+        "@hongdown/darwin-x64": "0.2.0-dev.67+1efd4bb7",
+        "@hongdown/linux-arm64": "0.2.0-dev.67+1efd4bb7",
+        "@hongdown/linux-x64": "0.2.0-dev.67+1efd4bb7",
+        "@hongdown/win32-arm64": "0.2.0-dev.67+1efd4bb7",
+        "@hongdown/win32-x64": "0.2.0-dev.67+1efd4bb7"
     }
 }