add typecript information regarding turndown-plugin-gfm (#11153)

Co-authored-by: Henry Heino <[email protected]>
laurent22 · Oct 11, 2024 · 447e463 · 447e463
1 parent b831525
commit 447e463
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/turndown-plugin-gfm/README.md b/packages/turndown-plugin-gfm/README.md
@@ -48,6 +48,17 @@ var turndownService = new TurndownService()
 turndownService.use(tables)
 ```
 
+### Typescript
+
+To use this in a typescript project, add this to a `declarations.d.ts` file, as described in https://www.npmjs.com/package/@joplin/turndown, and then add:
+
+```ts
+declare module "@joplin/turndown-plugin-gfm" {
+  export const gfm: any;
+  // Add other named exports if necessary
+}
+```
+
 ## License
 
 turndown-plugin-gfm is copyright © 2017+ Dom Christie and released under the MIT license.