Skip to content

Commit

Permalink
chore: add info about typedef-imports plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
wojtek-krysiak committed Jul 2, 2020
1 parent 31bd769 commit c0ca90d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,26 @@ Example configuration file with settings for both `default` and `better-docs` te
}
```

## Extras

### typedef(import(...))

better-docs also has one extra plugin for handling typescript'like types imports like:

```
/**
* @typedef {import('./some-other-file').ExportedType} ExportedType
*/
```

It simply removes that from the code so JSDoc wont throw an error. In order to use it add this plugin to your plugins section:

```
"plugins": [
"node_modules/better-docs/typedef-imports"
],
```

# Setting up for the development

If you want to change the theme locally follow the steps:
Expand Down

0 comments on commit c0ca90d

Please sign in to comment.