Socket
Book a DemoInstallSign in
Socket

joplin-turndown-plugin-gfm

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

joplin-turndown-plugin-gfm

Turndown plugin to add GitHub Flavored Markdown extensions.

1.0.12
latest
Source
npmnpm
Version published
Maintainers
1
Created
Source

turndown-plugin-gfm

A Turndown plugin which adds GitHub Flavored Markdown extensions.

This is a fork of the original turndown-plugin-gfm for use with Joplin. The changes are:

  • New: Always render tables even if they don't have a header.
  • New: Don't render the border of tables that contain other tables (frequent for websites that do the layout using tables). Only render the inner tables, if any, and if they also don't contain other tables.
  • New: Replace newlines (\n) with <br> inside table cells so that multi-line content is displayed correctly as Markdown.
  • New: Table cells are at least three characters long (padded with spaces) so that they render correctly in GFM-compliant renderers.
  • New: Handle colspan in TD tags
  • Fixed: Ensure there are no blank lines inside tables (due for example to an empty <tr> tag)
  • Fixed: Fixed importing tables that contain pipes.

Installation

npm:

npm install joplin-turndown-plugin-gfm

Usage

// For Node.js
var TurndownService = require('turndown')
var turndownPluginGfm = require('joplin-turndown-plugin-gfm')

var gfm = turndownPluginGfm.gfm
var turndownService = new TurndownService()
turndownService.use(gfm)
var markdown = turndownService.turndown('<strike>Hello world!</strike>')

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

  • strikethrough (for converting <strike>, <s>, and <del> elements)
  • tables
  • taskListItems
  • gfm (which applies all of the above)

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

var tables = require('turndown-plugin-gfm').tables
var turndownService = new TurndownService()
turndownService.use(tables)

License

turndown-plugin-gfm is copyright © 2017+ Dom Christie and released under the MIT license.

Keywords

turndown

FAQs

Package last updated on 08 Jan 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.