{"_id":"@digitallinguistics/ling-md","_rev":"4-58c4b6221e988a667722dc2c0703dc6c","name":"@digitallinguistics/ling-md","dist-tags":{"latest":"0.2.3"},"versions":{"0.1.0":{"name":"@digitallinguistics/ling-md","version":"0.1.0","keywords":["linguistics","markdown"],"author":{"url":"https://github.com/dwhieb","name":"Daniel W. Hieber"},"license":"MIT","_id":"@digitallinguistics/ling-md@0.1.0","maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"homepage":"https://github.com/digitallinguistics/ling-md#readme","bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"dist":{"shasum":"ab4c28a3f87486f5a9fa10e767b612bdf29180c4","tarball":"https://registry.npmjs.org/@digitallinguistics/ling-md/-/ling-md-0.1.0.tgz","fileCount":18,"integrity":"sha512-54m/mBk79ijbygLOmuTdc1BP7U6/gqQn6OQgjYCddKW0anynUkGxZLs3iZk6akUutNGSLW/77X81ZmvwA/z+4Q==","signatures":[{"sig":"MEUCIFkchhFg3gXmIZ0OTkEaIZ5bHTWtuYSoEpqt++EUTF8ZAiEAnLodpPuxKHBh3QzoUsexmtvxWymyGjXR05o7A8dYFw8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38524},"main":"index.js","type":"module","gitHead":"72cb0cd6e32f5b495232b3f1c0262de1f744c442","scripts":{"test":"node --test","stop-only":"stop-only --file index.test.js"},"_npmUser":{"name":"dwhieb","email":"dwhieb@gmail.com"},"repository":{"url":"git+https://github.com/digitallinguistics/ling-md.git","type":"git"},"_npmVersion":"10.8.3","description":"A JS library to convert linguistics-flavored markdown to HTML.","directories":{},"_nodeVersion":"22.9.0","dependencies":{"js-yaml":"^4.1.0","markdown-it":"^14.1.0","markdown-it-ib":"^2.0.0","markdown-it-ins":"^4.0.0","markdown-it-sub":"^2.0.0","markdown-it-sup":"^2.0.0","markdown-it-mark":"^4.0.0","markdown-it-attrs":"^4.2.0","@mdit/plugin-alert":"^0.13.1","markdown-it-anchor":"^9.2.0","markdown-it-deflist":"^3.0.0","@mdit/plugin-mathjax":"^0.13.1","markdown-it-footnote":"^4.0.0","@mdit/plugin-tasklist":"^0.13.1","markdown-it-for-inline":"^2.0.1","markdown-it-collapsible":"^2.0.2","markdown-it-table-captions":"^1.0.4","markdown-it-bracketed-spans":"^1.0.1","@digitallinguistics/dlx2html":"^0.4.0","markdown-it-table-of-contents":"^0.8.0","@digitallinguistics/scription2dlx":"^0.14.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.1","eslint":"^9.9.0","stop-only":"^3.4.0","@eslint/js":"^9.9.0","@stylistic/eslint-plugin-js":"^2.6.4","@digitallinguistics/eslint-config":"^0.5.2"},"_npmOperationalInternal":{"tmp":"tmp/ling-md_0.1.0_1728422343852_0.30572229761584957","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@digitallinguistics/ling-md","version":"0.2.0","keywords":["linguistics","markdown"],"author":{"url":"https://github.com/dwhieb","name":"Daniel W. Hieber"},"license":"MIT","_id":"@digitallinguistics/ling-md@0.2.0","maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"homepage":"https://github.com/digitallinguistics/ling-md#readme","bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"dist":{"shasum":"8f68eadd4a4e559cb2d57ee1bec720f352e93c49","tarball":"https://registry.npmjs.org/@digitallinguistics/ling-md/-/ling-md-0.2.0.tgz","fileCount":18,"integrity":"sha512-0FA4kO/55PQrGfU3bQdPeV+jMRDM0cDSCpYjvhRDos0PItIHBJcssdfcVCKsrVMiFWjPCiFtlN9/70d+zgW9wA==","signatures":[{"sig":"MEYCIQDuHt+1CAiyepQYSh2wb3QAsKDJlXg+xAVjN7XFBKhxmAIhAOOtGSu9WNS/vLhsLucngZPE1YpCjkcxPKoTKzsWocsS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":40805},"main":"index.js","type":"module","gitHead":"158d4a363b05dfe53b5688d272e1098efb295592","scripts":{"test":"node --test","stop-only":"stop-only --file index.test.js"},"_npmUser":{"name":"dwhieb","email":"dwhieb@gmail.com"},"repository":{"url":"git+https://github.com/digitallinguistics/ling-md.git","type":"git"},"_npmVersion":"10.8.3","description":"A JS library to convert linguistics-flavored markdown to HTML.","directories":{},"_nodeVersion":"22.9.0","dependencies":{"js-yaml":"^4.1.0","markdown-it":"^14.1.0","markdown-it-ib":"^2.0.0","@mdit/plugin-dl":"^0.13.1","@mdit/plugin-ins":"^0.13.1","@mdit/plugin-sub":"^0.13.1","@mdit/plugin-sup":"^0.13.1","@mdit/plugin-mark":"^0.13.1","@mdit/plugin-alert":"^0.13.1","@mdit/plugin-attrs":"^0.13.1","markdown-it-anchor":"^9.2.0","@mdit/plugin-mathjax":"^0.13.1","@mdit/plugin-footnote":"^0.13.1","@mdit/plugin-tasklist":"^0.13.1","markdown-it-for-inline":"^2.0.1","markdown-it-collapsible":"^2.0.2","markdown-it-table-captions":"^1.0.4","markdown-it-bracketed-spans":"^1.0.1","@digitallinguistics/dlx2html":"^0.4.0","markdown-it-table-of-contents":"^0.8.0","@digitallinguistics/scription2dlx":"^0.14.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.1","eslint":"^9.9.0","stop-only":"^3.4.0","@eslint/js":"^9.9.0","@stylistic/eslint-plugin-js":"^2.6.4","@digitallinguistics/eslint-config":"^0.5.2"},"_npmOperationalInternal":{"tmp":"tmp/ling-md_0.2.0_1728427620054_0.27512035169294813","host":"s3://npm-registry-packages"}},"0.2.1":{"name":"@digitallinguistics/ling-md","version":"0.2.1","keywords":["linguistics","markdown"],"author":{"url":"https://github.com/dwhieb","name":"Daniel W. Hieber"},"license":"MIT","_id":"@digitallinguistics/ling-md@0.2.1","maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"homepage":"https://github.com/digitallinguistics/ling-md#readme","bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"dist":{"shasum":"94062b0a87c3d20a242e2538413ddb0ae3a5cf1c","tarball":"https://registry.npmjs.org/@digitallinguistics/ling-md/-/ling-md-0.2.1.tgz","fileCount":18,"integrity":"sha512-Sloerm/t3G+DKYaHqiCdfDJ45XeCUIahv2C97rLHpywlONpzPqhD42Mnafc1A0E+f1cPFO4ELde+BI2YHqyBCw==","signatures":[{"sig":"MEUCIQCmtfBEZe2tyboJXOR0hI4IQdp4ncEeI2024T1qoLq5PQIgNCMz0R/81eZIBbUs1xC2pzi+TRUAXHh1iDsUSqOeyKM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":40796},"main":"index.js","type":"module","gitHead":"63162f0ff237f4559dfeddc67e3e487e6de1b3b3","scripts":{"test":"node --test","stop-only":"stop-only --file index.test.js"},"_npmUser":{"name":"dwhieb","email":"dwhieb@gmail.com"},"repository":{"url":"git+https://github.com/digitallinguistics/ling-md.git","type":"git"},"_npmVersion":"10.8.3","description":"A JS library to convert linguistics-flavored markdown to HTML.","directories":{},"_nodeVersion":"22.9.0","dependencies":{"js-yaml":"^4.1.0","markdown-it":"^14.1.0","markdown-it-ib":"^2.0.0","@mdit/plugin-dl":"^0.13.1","@mdit/plugin-ins":"^0.13.1","@mdit/plugin-sub":"^0.13.1","@mdit/plugin-sup":"^0.13.1","@mdit/plugin-mark":"^0.13.1","@mdit/plugin-alert":"^0.13.1","@mdit/plugin-attrs":"^0.13.1","markdown-it-anchor":"^9.2.0","@mdit/plugin-mathjax":"^0.13.1","@mdit/plugin-footnote":"^0.13.1","@mdit/plugin-tasklist":"^0.13.1","markdown-it-for-inline":"^2.0.1","markdown-it-collapsible":"^2.0.2","markdown-it-table-captions":"^1.0.4","markdown-it-toc-done-right":"^4.2.0","markdown-it-bracketed-spans":"^1.0.1","@digitallinguistics/dlx2html":"^0.4.0","@digitallinguistics/scription2dlx":"^0.14.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.1","eslint":"^9.9.0","stop-only":"^3.4.0","@eslint/js":"^9.9.0","@stylistic/eslint-plugin-js":"^2.6.4","@digitallinguistics/eslint-config":"^0.5.2"},"_npmOperationalInternal":{"tmp":"tmp/ling-md_0.2.1_1728428803564_0.10678348382849356","host":"s3://npm-registry-packages"}},"0.2.2":{"name":"@digitallinguistics/ling-md","version":"0.2.2","keywords":["linguistics","markdown"],"author":{"url":"https://github.com/dwhieb","name":"Daniel W. Hieber"},"license":"MIT","_id":"@digitallinguistics/ling-md@0.2.2","maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"homepage":"https://github.com/digitallinguistics/ling-md#readme","bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"dist":{"shasum":"e6f68b641d08de05ce88b1777e3857a8617bdcda","tarball":"https://registry.npmjs.org/@digitallinguistics/ling-md/-/ling-md-0.2.2.tgz","fileCount":18,"integrity":"sha512-neAk/Ju/XoKr+aernOQQ9DZYf0DXqy3OkxBijfJQ544TlO+yQCNXp7OEsA7zQv6TvqdrlTI5hOzjSJRNcGWPWQ==","signatures":[{"sig":"MEQCIEwjM+S7gcMTSijjXf4s7YcdjPQeNhYMUOaz3PD762RzAiAu82PsxJprbGNlD3/UFFRR+5d64+0BpSk+IhZ5GqIvIA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":40795},"main":"index.js","type":"module","gitHead":"5cbcd13668e4b4983375d69196f10382adedd56a","scripts":{"test":"node --test","stop-only":"stop-only --file index.test.js"},"_npmUser":{"name":"dwhieb","email":"dwhieb@gmail.com"},"repository":{"url":"git+https://github.com/digitallinguistics/ling-md.git","type":"git"},"_npmVersion":"10.8.3","description":"A JS library to convert linguistics-flavored markdown to HTML.","directories":{},"_nodeVersion":"22.9.0","dependencies":{"js-yaml":"^4.1.0","markdown-it":"^14.1.0","markdown-it-ib":"^2.0.0","@mdit/plugin-dl":"^0.13.1","@mdit/plugin-ins":"^0.13.1","@mdit/plugin-sub":"^0.13.1","@mdit/plugin-sup":"^0.13.1","@mdit/plugin-mark":"^0.13.1","@mdit/plugin-alert":"^0.13.1","@mdit/plugin-attrs":"^0.13.1","markdown-it-anchor":"^9.2.0","@mdit/plugin-mathjax":"^0.13.1","@mdit/plugin-footnote":"^0.13.1","@mdit/plugin-tasklist":"^0.13.1","markdown-it-for-inline":"^2.0.1","markdown-it-collapsible":"^2.0.2","markdown-it-table-captions":"^1.0.4","markdown-it-toc-done-right":"^4.2.0","markdown-it-bracketed-spans":"^1.0.1","@digitallinguistics/dlx2html":"^0.4.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.1","eslint":"^9.9.0","stop-only":"^3.4.0","@eslint/js":"^9.9.0","@stylistic/eslint-plugin-js":"^2.6.4","@digitallinguistics/eslint-config":"^0.5.2","@digitallinguistics/scription2dlx":"0.14.1"},"_npmOperationalInternal":{"tmp":"tmp/ling-md_0.2.2_1728613611368_0.4405446195379936","host":"s3://npm-registry-packages"}},"0.2.3":{"name":"@digitallinguistics/ling-md","version":"0.2.3","description":"A JS library to convert linguistics-flavored markdown to HTML.","keywords":["linguistics","markdown"],"homepage":"https://github.com/digitallinguistics/ling-md#readme","bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"license":"MIT","author":{"name":"Daniel W. Hieber","url":"https://github.com/dwhieb"},"repository":{"type":"git","url":"git+https://github.com/digitallinguistics/ling-md.git"},"main":"index.js","type":"module","scripts":{"stop-only":"stop-only --file index.test.js","test":"node --test"},"publishConfig":{"access":"public"},"devDependencies":{"@digitallinguistics/eslint-config":"^0.5.2","@eslint/js":"^9.9.0","@stylistic/eslint-plugin-js":"^2.6.4","chai":"^5.1.1","eslint":"^9.9.0","stop-only":"^3.4.0"},"dependencies":{"@digitallinguistics/dlx2html":"^0.4.0","@digitallinguistics/scription2dlx":"0.14.1","@mdit/plugin-alert":"^0.13.1","@mdit/plugin-attrs":"^0.13.1","@mdit/plugin-dl":"^0.13.1","@mdit/plugin-footnote":"^0.13.1","@mdit/plugin-ins":"^0.13.1","@mdit/plugin-mark":"^0.13.1","@mdit/plugin-mathjax":"^0.13.1","@mdit/plugin-sub":"^0.13.1","@mdit/plugin-sup":"^0.13.1","@mdit/plugin-tasklist":"^0.13.1","js-yaml":"^4.1.0","markdown-it":"^14.1.0","markdown-it-anchor":"^9.2.0","markdown-it-bracketed-spans":"^1.0.1","markdown-it-collapsible":"^2.0.2","markdown-it-for-inline":"^2.0.1","markdown-it-ib":"^2.0.0","markdown-it-table-captions":"^1.0.4","markdown-it-toc-done-right":"^4.2.0"},"_id":"@digitallinguistics/ling-md@0.2.3","gitHead":"62d37cd24d3e86f186f7595ec84580fc41817554","_nodeVersion":"22.9.0","_npmVersion":"10.8.3","dist":{"integrity":"sha512-DXHYpG9/zuYMes1gLaQy92A41l9w1PX2jVajxARzNcYPv0LD4P+SAOhkVYg/9dL1y8zXdZ+LLxuwWBxgewf6HQ==","shasum":"403e9a83ade4e6406449ffe4f5dd8e6a1225d50b","tarball":"https://registry.npmjs.org/@digitallinguistics/ling-md/-/ling-md-0.2.3.tgz","fileCount":18,"unpackedSize":40795,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC4unfZrRVoGkImfwhKcUY4la/dCuiUpoiqnHRapVMqpAiEA1kk2R23V+WJG71sY42w0/EPWTVpWmc9WlLpDAGMN7Rw="}]},"_npmUser":{"name":"dwhieb","email":"dwhieb@gmail.com"},"directories":{},"maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ling-md_0.2.3_1728613914197_0.35403091477305315"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-08T21:19:03.768Z","modified":"2024-10-11T02:31:54.629Z","0.1.0":"2024-10-08T21:19:04.109Z","0.2.0":"2024-10-08T22:47:00.218Z","0.2.1":"2024-10-08T23:06:43.734Z","0.2.2":"2024-10-11T02:26:51.603Z","0.2.3":"2024-10-11T02:31:54.427Z"},"bugs":{"url":"https://github.com/digitallinguistics/ling-md/issues"},"author":{"name":"Daniel W. Hieber","url":"https://github.com/dwhieb"},"license":"MIT","homepage":"https://github.com/digitallinguistics/ling-md#readme","keywords":["linguistics","markdown"],"repository":{"type":"git","url":"git+https://github.com/digitallinguistics/ling-md.git"},"description":"A JS library to convert linguistics-flavored markdown to HTML.","maintainers":[{"name":"dwhieb","email":"dwhieb@gmail.com"}],"readme":"# ling-md\n\nA JS library to convert [linguistics-flavored markdown][spec] to HTML.\n\nThis library uses [markdown-it] for converting markdown, with a few custom extensions specific to the ling-md format (see [Notes](#usage-notes) below for details). It also enables several commonly-used markdown extensions that are also relevant to linguistics (such as footnotes).\n\nAfter conversion, you'll probably still want to apply additional CSS styles to the HTML. For example, grammatical glosses like `^^fut^^` are converted to abbreviation tags such as `<abbr>fut</abbr>`, but abbreviation tags are not styled in smallcaps by default.\n\n## Usage\n\nInstall the library:\n\n```cmd\nnpm i @digitallinguistics/ling-md\n```\n\nCreate a new parser instance and parse the linguistics-flavored markdown:\n\n```js\nimport Parser from '@digitallinguistics/ling-md'\n\nconst markdown = `The word *perro* in Spanish means ''dog''.`\nconst parser   = new Parser({ /* options */ })\nconst html     = parser.parse(markdown)\n\nconsole.log(html) // <p>The word <i>perro</i> in Spanish means <q>dog</q>.</p>\n```\n\n## Features\n\nThe library enables the following features by default:\n\n### Linguistics\n\n| Feature             | Markdown                                                                                                                 | HTML                                             |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |\n| grammatical glosses | `^^fut^^`                                                                                                                | `<abbr class=\"gl\">fut</abbr>`                    |\n| inline examples     | `The word *perro* is Spanish.`                                                                                           | `<p>The word <i>perro</i> is Spanish.</p>`       |\n| inline translations | `The word *perro* means ''dog''.`                                                                                        | `<p>The word <i>perro</i> means <q>dog</q>.</p>` |\n| interlinear glosses | <pre><code>\\```igl<br>ninakupenda<br>ni-na-ku-pend-a<br>1sg.SUBJ-PRES-2sg.OBJ-love-IND<br>I love you<br>```</code></pre> | [See documentation here.][dlx2html]              |\n\n### General\n\n| Feature                | Markdown                                                                                                     | HTML                                                                                   |\n| ---------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |\n| alerts                 | <pre><code>&gt; [!note]<br>&gt; Note Text</code></pre>                                                       | [See documentation here.][alert]                                                       |\n| block attributes       | `# Heading {#intro}`                                                                                         | `<h1 id=intro>Heading</h1>`                                                            |\n| bracketed spans        | `[/lɪŋˈɡwɪstɪks/]{.phon}`                                                                                    | `<span class=\"phon\">/lɪŋˈɡwɪstɪks/</span>`                                             |\n| checklists             | [See documentation here.][checklists]                                                                        |                                                                                        |\n| definition lists       | [See documentation here.][def-lists]                                                                         |                                                                                        |\n| fenced code attributes | <pre><code>\\```js {.code-example}<br>console.log('Hello world!')<br>```</code></pre>                         | `<pre><code class=\"language-js code-example\">console.log('Hello world!')</code></pre>` |\n| footnotes              | <pre><code>Here is a footnote reference,[^1] and some more text.\\n\\n[^1]: Here is the footnote.</code></pre> | [See example here.][fn]                                                                |\n| header anchors         | `# Header Title`                                                                                             | `<h1 id=\"header-title\">Header Title</h1>`                                              |\n| HTML                   | `<b>bold</b>`                                                                                                | `<b>bold</b>`                                                                          |\n| inline attributes      | `*perro*{.example lang=spa}`                                                                                 | `<i class=\"example\" lang=\"spa>perro</i>`                                               |\n| inserted text          | `++inserted text++`                                                                                          | `<ins>inserted text</ins>`                                                             |\n| marked text            | `==marked text==`                                                                                            | `<mark>marked text</mark>`                                                             |\n| math (LaTeX)           | `Euler’s identity $e^{i\\pi}+1=0$ is a beautiful formula in $\\mathbb{R}^2$.`                                  | (Outputs an image.)                                                                    |\n| smart quotes           | `\"Hello world!\"`                                                                                             | `“Hello world!”`                                                                       |\n| tables                 | [See documentation here.][tables]                                                                            |                                                                                        |\n| strikethrough          | `~~This was mistaken text.~~`                                                                                | `<s>This was mistaken text.</s>`                                                       |\n| subscript              | `~subscript~`                                                                                                | `<sub>subscript</sub>`                                                                 |\n| summary + details      | [See documentation here.][summary-details]                                                                   |                                                                                        |\n| superscript            | `^superscript^`                                                                                              | `<sup>superscript</sup>`                                                               |\n| table captions         | [See documentation here][table-captions]                                                                     |                                                                                        |\n| table of contents      | `[[toc]]`                                                                                                    | [See documentation here.][toc]                                                         |\n| typography             | `-- --- ... 1st 2nd 3rd 4th 1/3 3/4`                                                                         | `– — … 1<sup>st</sup> 2<sup>nd</sup> 3<sup>rd</sup> 4<sup>th</sup> ⅓ ¾`                |\n\n## Usage Notes\n\n- Most markdown libraries convert single asterisks (`*perro*`) to emphasis (`<em>perro</em>`), but `ling-md` converts them to [idiomatic text][i] (`<i>perro</i>`). Use `**double asterisks**` for bold instead. (See [\"you're using &lt;em&gt; wrong\"][em-article] by Facundo Corradini for more information.)\n- Attributes may be added in a variety of formats. See the [`attributes-parser`][attrs-parser] library for a complete list. The most common ones are:\n  - `.className` > `class=\"className\"`\n  - `#name` > `id=\"name\"`\n  - `attr=val` > `attr=\"val\"` (`data-*` attributes also work)\n- There is no markdown shortcut for underlining. Use the `<u>` tag instead.\n- You can enter interlinear glossed examples in [Scription] format, using fenced code blocks, like so:\n\n  ````\n  ```igl\n  ninakupenda\n  ni-na-ku-pend-a\n  1sg.SUBJ-PRES-2sg.OBJ-love-IND\n  I love you\n  ```\n  ````\n\n  Note that you can enter multiple examples in a single code block, separated by a blank line.\n\n  You can also pass options to both the `scription2dlx` and `dlx2html` libraries by including those options in the YAML header of the interlinear, like so:\n\n  ````\n  ```igl\n  ---\n  dlx2html:\n    glosses: true\n  scription2dlx:\n    emphasis: false\n  ---\n\n  ninakupenda\n  ni-na-ku-pend-a\n  1sg.SUBJ-PRES-2sg.OBJ-love-IND\n  I love you\n  ```\n  ````\n\n## API\n\n### `marked`\n\nProvides access to the `marked` instance for further customization.\n\n### `parse(md)`\n\nParse a markdown string using the current options and return HTML.\n\n### Options\n\n| Option          | Type      | Default                                                                | Description                                                                                                                                                                                                                                                                                                                  |\n| --------------- | --------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dlx2html`      | Object    | [See documentation here.][dlx2html]                                    | Options to pass to `dlx2html` (the library that converts interlinear examples to HTML). If options are provided in a YAML header within fenced code blocks, those options override these ones.                                                                                                                               |\n| `markdown`      | Object    | <pre><code>{<br>  html: true,<br>  typographer: true<br>}</code></pre> | Options to pass to `markdown-it`. `typographer` and `html` are enabled by default.                                                                                                                                                                                                                                           |\n| `plugins`       | Object    | `{}`                                                                   | Options to pass to any of the `markdown-it` plugins. Each key should be the name of the plugin, and the value is the options to pass to it. Example: `{ '@mdit/plugin-alert': { /* options */ } }` You can see a complete list of the `markdown-it` plugins that are used in this library in the source code [here][source]. |\n| `translations`  | `span\\|q` | `span`                                                                 | Whether to use `<span class=tln>` or a `<q>` element for translations. `<span>`s will wrap the inner text in single quotes.                                                                                                                                                                                                  |\n| `scription2dlx` | Object    | [See documentation here.][scription2html]                              | Options to pass to `scription2html` (the library that parses interlinear examples). If options are provided in a YAML header within fenced code blocks, those options override these ones.                                                                                                                                   |\n\n<!-- LINKS -->\n[alert]:           https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts\n[attrs-parser]:    https://www.npmjs.com/package/attributes-parser\n[checklists]:      https://www.markdownguide.org/extended-syntax/#task-lists\n[def-lists]:       https://pandoc.org/MANUAL.html#definition-lists\n[dlx2html]:        https://github.com/digitallinguistics/dlx2html\n[em-article]:      https://blog.logrocket.com/youre-using-em-wrong/\n[fn]:              https://mdit-plugins.github.io/footnote.html\n[i]:               https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i\n[markdown-it]:     https://github.com/markdown-it/markdown-it#readme\n[Scription]:       https://scription.digitallinguistics.io/\n[scription2html]:  https://github.com/digitallinguistics/scription2html\n[spec]:            https://github.com/digitallinguistics/ling-markdown-spec\n[source]:          https://github.com/digitallinguistics/ling-md/blob/main/index.js\n[summary-details]: https://www.npmjs.com/package/markdown-it-collapsible\n[table-captions]:  https://github.com/martinring/markdown-it-table-captions\n[tables]:          https://www.markdownguide.org/extended-syntax/#tables\n[toc]:             https://www.npmjs.com/package/markdown-it-table-of-contents\n","readmeFilename":"README.md"}