https://github.com/guyplusplus/turndown-plugin-confluence-to-gfm
Converts Confluence pages to Markdown GFM
https://github.com/guyplusplus/turndown-plugin-confluence-to-gfm
confluence gfm markdown turndown
Last synced: 6 months ago
JSON representation
Converts Confluence pages to Markdown GFM
- Host: GitHub
- URL: https://github.com/guyplusplus/turndown-plugin-confluence-to-gfm
- Owner: guyplusplus
- License: mit
- Created: 2021-04-15T08:50:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T05:27:39.000Z (over 1 year ago)
- Last Synced: 2025-09-19T23:28:56.302Z (9 months ago)
- Topics: confluence, gfm, markdown, turndown
- Language: HTML
- Homepage:
- Size: 169 KB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# turndown-plugin-confluence-to-gfm
A [Turndown](https://github.com/domchristie/turndown) plugin which adds GitHub Flavored Markdown extensions for Confluence pages exported as HTML. It relies on the [turndown-plugin-gfm](https://github.com/guyplusplus/turndown-plugin-gfm) plugin.
This small plugin converts few non-standard features of Confluence HTML content to GFM, namely:
* Code block (indented and fenced)
* Tasks list
* Emoji
## Test Page
The test page can be found [here](https://guyplusplus.github.io/turndown-plugin-confluence-to-gfm/).
## Installation
npm:
```
npm install turndown-plugin-confluence-to-gfm
```
Browser:
```html
```
## Usage
```js
// For Node.js
var TurndownService = require('turndown')
var TurndownPluginGfmService = require('@guyplusplus/turndown-plugin-gfm')
var TurndownPluginConfluenceToGfmService = require('turndown-plugin-confluence-to-gfm')
var turndownService = new TurndownService()
TurndownPluginGfmService.gfm(turndownService)
TurndownPluginConfluenceToGfmService.confluenceGfm(turndownService)
var markdown = turndownService.turndown('
')
```
turndown-plugin-confluence-to-gfm is a suite of plugins which can be applied individually. The available plugins are as follows:
- `indentedConfluenceHighlightedCodeBlock` and `fencedConfluenceHighlightedCodeBlock`
- `confluenceEmoji`
- `confluenceTaskListItems`
- `confluenceGfm` (which applies all of the above)
So for example, if you only wish to convert tables:
```js
var confluenceEmoji = require('turndown-plugin-confluence-to-gfm').confluenceEmoji
var turndownService = new TurndownService()
TurndownPluginGfmService.gfm(turndownService)
turndownService.use(confluenceEmoji)
```
## License
turndown-plugin-confluence-to-gfm is copyright © 2021+ Guyplusplus and released under the MIT license.