turnish-plugin-gfm


A Turnish plugin which adds GitHub Flavored Markdown extensions.

This is originally based on @joplin/turndown-plugin-gfm by Laurent Cozic, which is a fork of turndown-plugin-gfm by Dom Christie.

turnish-plugin-gfm vs @joplin/turndown-plugin-gfm

0538bf0

Installation

npm:

``sh
npm install turnish-plugin-gfm
`

yarn:

`sh
yarn add turnish-plugin-gfm
`

pnpm:

`sh
pnpm add turnish-plugin-gfm
`

Browser:

`html

`

Usage

For Node.js:

`js
const TurnishService = require('turnish')
const turnishPluginGfm = require('turnish-plugin-gfm')

const gfm = turnishPluginGfm.gfm
const turnishService = new TurnishService()
turnishService.use(gfm)
const markdown = turnishService.turnish('Hello world!')
`

ES module import (Node with ESM, bundlers, or browsers supporting modules):

`js
import TurnishService from 'turnish'
import turnishPluginGfm from 'turnish-plugin-gfm'

const gfm = turnishPluginGfm.gfm
const turnishService = new TurnishService()
turnishService.use(gfm)
const markdown = turnishService.turnish('Hello world!')
`

turnish-plugin-gfm is a suite of plugins which can be applied individually. The available plugins are as follows:

- strikethrough (for converting , , and elements)
- tables
- taskListItems
- gfm (which applies all of the above)

So for example, if you only wish to convert tables:

`js
const tables = require('turnish-plugin-gfm').tables
const turndownService = new TurndownService()
turndownService.use(tables)
`

License

MIT

- Copyright (c) 2026- Manabu Nakazawa
- Copyright (c) 2025-2026 Laurent22
- Copyright (c) 2017-2025 Dom Christie

This is originally based on @joplin/turndown-plugin-gfm (commit: 0538bf0`) by Laurent Cozic, which is a fork of turndown-plugin-gfm by Dom Christie. All of them are licensed under the MIT License.