@digitallinguistics/ling-md v0.2.3

ling-md

A JS library to convert linguistics-flavored markdown to HTML.

This library uses markdown-it for converting markdown, with a few custom extensions specific to the ling-md format (see Notes below for details). It also enables several commonly-used markdown extensions that are also relevant to linguistics (such as footnotes).

After 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.

Usage

Install the library:

npm i @digitallinguistics/ling-md

Create a new parser instance and parse the linguistics-flavored markdown:

import Parser from '@digitallinguistics/ling-md'

const markdown = `The word *perro* in Spanish means ''dog''.`
const parser   = new Parser({ /* options */ })
const html     = parser.parse(markdown)

console.log(html) // <p>The word <i>perro</i> in Spanish means <q>dog</q>.</p>

Features

The library enables the following features by default:

Linguistics

General

Usage Notes

• Most markdown libraries convert single asterisks (*perro*) to emphasis (<em>perro</em>), but ling-md converts them to idiomatic text (<i>perro</i>). Use **double asterisks** for bold instead. (See "you're using <em> wrong" by Facundo Corradini for more information.)
• Attributes may be added in a variety of formats. See the attributes-parser library for a complete list. The most common ones are:
  • .className > class="className"
  • #name > id="name"
  • attr=val > attr="val" (data-* attributes also work)
• There is no markdown shortcut for underlining. Use the <u> tag instead.

• You can enter interlinear glossed examples in Scription format, using fenced code blocks, like so:

  ```igl
  ninakupenda
  ni-na-ku-pend-a
  1sg.SUBJ-PRES-2sg.OBJ-love-IND
  I love you
  ```

  Note that you can enter multiple examples in a single code block, separated by a blank line.

  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:

  ```igl
  ---
  dlx2html:
    glosses: true
  scription2dlx:
    emphasis: false
  ---
  
  ninakupenda
  ni-na-ku-pend-a
  1sg.SUBJ-PRES-2sg.OBJ-love-IND
  I love you
  ```

API

marked

Provides access to the marked instance for further customization.

parse(md)

Parse a markdown string using the current options and return HTML.

Options