Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add specific setup instructions for Vue users #398

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add specific setup instructions for Vue users #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,22 @@ var turndownService = new TurndownService()
var markdown = turndownService.turndown('<h1>Hello world!</h1>')
```



Turndown also accepts DOM nodes as input (either element nodes, document nodes, or document fragment nodes):

```js
var markdown = turndownService.turndown(document.getElementById('content'))
```

If using Vue, you may see an error: `TypeError: TurndownService is not a constructor` when trying to import Turndown. To fix this, add `.default` to the import. In other words:
```js
// example.vue
const TurndownService = require('turndown').default
```



## Options

Options can be passed in to the constructor on instantiation. For example:
Expand Down