Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-08-17 15:42:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:laurent22/joplin-turndown-plugin-gfm

Browse Source
This commit is contained in:
Laurent Cozic 2018-05-21 23:22:44 +01:00
commit 0f64fe53cb
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,19 +2,17 @@
A [Turndown](https://github.com/domchristie/turndown) plugin which adds GitHub Flavored Markdown extensions. A [Turndown](https://github.com/domchristie/turndown) plugin which adds GitHub Flavored Markdown extensions.
This is a fork of the original [turndown-plugin-gfm](https://github.com/domchristie/turndown-plugin-gfm) for use with [Joplin](https://github.com/laurent22/joplin). The changes are:
- Always render tables even they don't have a header.
- 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.
## Installation ## Installation
npm: npm:
``` ```
npm install turndown-plugin-gfm npm install joplin-turndown-plugin-gfm
```
Browser:
```html
<script src="https://unpkg.com/turndown/dist/turndown.js"></script>
<script src="https://unpkg.com/turndown-plugin-gfm/dist/turndown-plugin-gfm.js"></script>
``` ```
## Usage ## Usage
@ -22,7 +20,7 @@ Browser:
```js ```js
// For Node.js // For Node.js
var TurndownService = require('turndown') var TurndownService = require('turndown')
var turndownPluginGfm = require('turndown-plugin-gfm') var turndownPluginGfm = require('joplin-turndown-plugin-gfm')
var gfm = turndownPluginGfm.gfm var gfm = turndownPluginGfm.gfm
var turndownService = new TurndownService() var turndownService = new TurndownService()