marked-abc 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MaddyGuthridge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# Marked ABC
+
+Render sheet music with [ABCjs](https://www.abcjs.net/) in Markdown documents
+using [Marked](https://marked.js.org/).
+
+## Usage
+
+This only renders in the browser.
+
+```js
+import {Marked} from "marked";
+import markedAbc from "marked-abc";
+
+const marked = new Marked();
+
+marked.use(markedAbc());
+
+marked.parse(`
+  <score lang="ABC">
+    X: 1
+    T: Epitome of an Enigma
+    C: Zarhym Raider
+    M: 2/2
+    L: 1/8
+    K: C#min
+    G2|g2 fe d2 c2 | B2 F2 G2 EF | G2 AB A2 G2 | F2 D2 E2 |]
+  </score>
+`);
+// Beautifully formatted sheet music as the output
+```
+
+## Options
+
+* `abcOptions`: [options for `abcjs.renderAbc`](https://docs.abcjs.net/visual/render-abc-options.html)
+* `sanitizer`: function to sanitize abcJS score. To minimize dependencies, this
+  library only performs basic escaping to HTML, meaning that maliciously-crafted
+  scores could perform an [XSS](https://en.wikipedia.org/wiki/Cross-site_scripting)
+  attack. If your scores are user-generated and can be shared, you should use a
+  library such as [`DOMPurify`](https://www.npmjs.com/package/dompurify) to
+  maximize the safety of the rendering.

package/lib/index.d.ts

@@ -0,0 +1,18 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import * as abcjs from 'abcjs';
+import { MarkedExtension } from 'marked';
+
+export type MarkedAbcOptions = {
+	/** Options to pass to ABCjs */
+	abcOptions?: abcjs.AbcVisualParams;
+	/** Sanitizer function */
+	sanitizer?: (text: string) => string;
+};
+declare function _default(options?: MarkedAbcOptions): MarkedExtension;
+
+export {
+	_default as default,
+};
+
+export {};