feat(core): projectDocuments implementation

typedoc2md · May 8, 2024 · 4b55291 · 4b55291
1 parent ee0a95e
commit 4b55291
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/CHANGELOG.md b/packages/typedoc-plugin-markdown/test/fixtures/CHANGELOG.md
@@ -0,0 +1 @@
+# TEST CHANGELOG
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts
@@ -213,6 +213,20 @@ const config: Record<string, Fixture> = {
       },
     ],
   },
+  documents: {
+    only: true,
+    entryPoints: '/documents/index.ts',
+    commonOptions: {
+      plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')],
+      hidePageHeader: true,
+      hideBreadcrumbs: true,
+    },
+    options: [
+      {
+        projectDocuments: ['./CHANGELOG.md'],
+      },
+    ],
+  },
 };
 
 export default config;
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/documents/index.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/documents/index.ts
@@ -0,0 +1,6 @@
+/**
+ * @module
+ */
+
+export function someFunction() {}
+export class SomeClass {}