marked-abc 0.1.3 → 0.2.0

package/README.md

@@ -14,7 +14,7 @@ import markedAbc from "marked-abc";
 
 const marked = new Marked();
 
-marked.use(markedAbc());
+marked.use(markedAbc().extension);
 
 marked.parse(`
   <score lang="ABC">
@@ -30,6 +30,20 @@ marked.parse(`
 // Beautifully formatted sheet music as the output
 ```
 
+## Usage with server-side rendering
+
+When this extension is used in a server-side context, it will fall back to
+rendering plaintext. When the Markdown element is mounted, you can convert these
+elements to rendered notation by using the returned `forceRenderAll` function.
+
+```js
+const abc = markedAbc();
+
+marked.use(abc.extension);
+
+onMount(() => abc.forceRenderAll());
+```
+
 ## Options
 
 * `abcOptions`: [options for `abcjs.renderAbc`](https://docs.abcjs.net/visual/render-abc-options.html)

package/lib/index.d.ts

@@ -9,7 +9,10 @@ export type MarkedAbcOptions = {
 	/** Sanitizer function */
 	sanitizer?: (text: string) => string;
 };
-declare function _default(options?: MarkedAbcOptions): MarkedExtension;
+declare function _default(options?: MarkedAbcOptions): {
+	extension: MarkedExtension;
+	forceRenderAll: () => void;
+};
 
 export {
 	_default as default,