@thi.ng/hiccup-markdown 3.2.167 → 3.2.169

package/README.md

@@ -296,15 +296,15 @@ defaults/outputs.
 
 Example with custom link elements:
 
-```ts
+```ts tangle:export/readme-parse.ts
 import { parse, type TagTransforms } from "@thi.ng/hiccup-markdown";
 
 const tags: Partial<TagTransforms> = {
-    link: (ctx, href, body) => ["a.link.blue", { href }, ...body]
+    link: (ctx, href, title, body) => ["a.link.blue", { href }, ...body]
 };
 
 // parse with custom tag transform overrides
-parse("[label](url)", { tags }).result;
+console.log(parse("[label](url)", { tags }).result);
 // [
 //   ["p", {}, ["a.link.blue", { href: "url" }, "label"]]
 // ]
@@ -312,14 +312,14 @@ parse("[label](url)", { tags }).result;
 
 ### Serializing to HTML
 
-```ts
+```ts tangle:export/readme-serialize.ts
 import { serialize } from "@thi.ng/hiccup";
 import { parse } from "@thi.ng/hiccup-markdown";
 
 const src = `# Hello world\n[This is a _test_](http://example.com) :smile:`;
 
 // convert to hiccup tree
-parse(src).result
+console.log(parse(src).result);
 // [
 //   [ "h1", { id: "hello-world" }, "Hello world" ],
 //   [
@@ -336,8 +336,8 @@ parse(src).result
 //   ]
 // ]
 
-// or serialize to HTML
-serialize(parse(src).result);
+// roundtrip, serialize back to HTML
+console.log(serialize(parse(src).result));
 // <h1 id="hello-world">Hello world</h1><p><a href="http://example.com">This is a <em>test</em></a> 😄</p>
 ```
 
@@ -387,7 +387,7 @@ See source code for reference.
 
 ### Usage examples
 
-```ts
+```ts tangle:export/readme-serialize2.ts
 import { serialize } from "@thi.ng/hiccup-markdown";
 
 // list component
@@ -408,6 +408,7 @@ const thingLink = (_, id, label) =>
 
 // Note: the same hiccup tree can be serialized to HTML via @thi.ng/hiccup or
 // used interactively in the browser w/ @thi.ng/hdom
+console.log(
 serialize(
     ["div",
         ["h1", "Hello Markdown"],
@@ -441,6 +442,7 @@ serialize(
     // optional context object passed to all component functions
     { magic: 42 }
 )
+);
 ```
 
 Resulting Markdown:

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thi.ng/hiccup-markdown",
-	"version": "3.2.167",
+	"version": "3.2.169",
 	"description": "Markdown parser & serializer from/to Hiccup format",
 	"type": "module",
 	"module": "./index.js",
@@ -39,17 +39,17 @@
 		"tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
 	},
 	"dependencies": {
-		"@thi.ng/api": "^8.12.6",
-		"@thi.ng/arrays": "^2.13.15",
-		"@thi.ng/checks": "^3.7.22",
-		"@thi.ng/defmulti": "^3.0.82",
-		"@thi.ng/emoji": "^1.0.25",
-		"@thi.ng/errors": "^2.5.46",
-		"@thi.ng/hiccup": "^5.3.28",
-		"@thi.ng/logger": "^3.2.5",
-		"@thi.ng/parse": "^2.6.34",
-		"@thi.ng/strings": "^3.9.26",
-		"@thi.ng/text-canvas": "^3.0.96"
+		"@thi.ng/api": "^8.12.7",
+		"@thi.ng/arrays": "^2.13.16",
+		"@thi.ng/checks": "^3.7.23",
+		"@thi.ng/defmulti": "^3.0.83",
+		"@thi.ng/emoji": "^1.0.26",
+		"@thi.ng/errors": "^2.5.47",
+		"@thi.ng/hiccup": "^5.3.29",
+		"@thi.ng/logger": "^3.2.6",
+		"@thi.ng/parse": "^2.6.35",
+		"@thi.ng/strings": "^3.9.27",
+		"@thi.ng/text-canvas": "^3.0.97"
 	},
 	"devDependencies": {
 		"esbuild": "^0.25.11",
@@ -101,5 +101,5 @@
 		],
 		"year": 2018
 	},
-	"gitHead": "136a5e5ef0b69e82329db00d806c3c4e8f1aa063\n"
+	"gitHead": "fc8b300a00eb479497b27467900b13d3152089ad\n"
 }

package/serialize.d.ts

@@ -5,6 +5,16 @@ export interface SerializeState {
     pre?: boolean;
     blockquote?: boolean;
 }
-export declare const serialize: (tree: any, ctx: any) => string;
+/**
+ * Serializes given hiccup tree to Markdown. The optional provided context `ctx`
+ * arg can be used to provide arbitrary state to components/functions embedded
+ * in the tree. See [thi.ng/hiccup
+ * docs](https://docs.thi.ng/umbrella/hiccup/index.html#user-context-injection)
+ * for details.
+ *
+ * @param tree
+ * @param ctx
+ */
+export declare const serialize: (tree: any, ctx?: any) => string;
 export declare const serializeElement: import("@thi.ng/defmulti").MultiFn3<any, any, SerializeState, string>;
 //# sourceMappingURL=serialize.d.ts.map