fix: TypeDoc compatibility fixes.

tgreyuk · Feb 14, 2024 · 49d9d03 · 49d9d03
1 parent 0116d54
commit 49d9d03
Show file tree

Hide file tree

Showing 3 changed files with 511 additions and 892 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 # typedoc-plugin-inline-sources
 
-A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that inlines source code into comments.
+A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that inlines source code into documentation.
 
-[![npm](https://img.shields.io/npm/v/typedoc-plugin-inline-sources.svg)](https://www.npmjs.com/package/typedoc-plugin-inline-sources)
-![CI](https://github.com/tgreyuk/typedoc-plugin-inline-sources/actions/workflows/ci.yml/badge.svg?branch=main)
+[![npm](https://img.shields.io/npm/v/typedoc-plugin-inline-sources.svg)](https://www.npmjs.com/package/typedoc-plugin-inline-sources) ![CI](https://github.com/tgreyuk/typedoc-plugin-inline-sources/actions/workflows/ci.yml/badge.svg?branch=main)
 
 ## What it does?
 
@@ -27,30 +26,9 @@ Simply use the `@source` annotation in your comments. This will create a tag wit
  *
  * @source source tag comment?
  */
-export const message = 'Hello World!';
+export const message = "Hello World!";
 ```
 
-### Model
-
-```
-Comment {
-  tags: [
-    {
-      tagName: 'source',
-      text: 'source tag comment?\n' +
-        '\n' +
-        '```typescript\n' +
-        'export const message = "Hello World!";\n' +
-        '```\n' +
-        '\n'
-    }
-  ],
-  shortText: 'Comments for variable',
-}
-```
-
-### Output (default theme)
+### Output
 
 ![image](https://user-images.githubusercontent.com/11680870/120396197-0f726800-c32e-11eb-800e-8cf7466635bb.png)
-
-