examples/vuepress-next/package.json

@@ -8,7 +8,7 @@
   },
   "devDependencies": {
     "typedoc-plugin-markdown": "*",
-    "vuepress": "^2.0.0-beta.53",
+    "vuepress": "next",
     "vuepress-plugin-typedoc": "*"
   }
 }

examples/vuepress/package.json

@@ -8,9 +8,7 @@
   },
   "devDependencies": {
     "typedoc-plugin-markdown": "*",
-    "vue": "^2.6.10",
-    "vue-server-renderer": "2.6.11",
-    "vuepress": "^1.8.2",
+    "vuepress": "^1.9.9",
     "vuepress-plugin-typedoc": "*"
   }
 }

package.json

@@ -29,7 +29,7 @@
     "prettier": "^2.8.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.24.4",
+    "typedoc": "^0.24.8",
     "typedoc-plugin-mdn-links": "^3.0.3",
     "typescript": "^4.9.3"
   }

packages/docusaurus-plugin-typedoc/README.md

@@ -67,7 +67,7 @@ Once built the docs will be available at `/docs/api` (or equivalent out director
 
 ### TypeDoc options
 
-To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/guides/options/) to the config.
+To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/options/) to the config.
 
 At a minimum the `entryPoints` and `tsconfig` options will need to be set.
 

packages/docusaurus-plugin-typedoc/src/render.ts

@@ -3,6 +3,7 @@ import {
   Application,
   BooleanDeclarationOption,
   MixedDeclarationOption,
+  PackageJsonReader,
   ParameterType,
   ProjectReflection,
   RendererEvent,
@@ -46,6 +47,7 @@ export async function render(
 }
 
 const addTypedocReaders = (app: Application) => {
+  app.options.addReader(new PackageJsonReader())
   app.options.addReader(new TypeDocReader());
   app.options.addReader(new TSConfigReader());
 };

packages/typedoc-plugin-markdown/README.md

@@ -35,8 +35,6 @@ This plugin provides additional options beyond the normal options that are [prov
   Do not render breadcrumbs in template header. Defaults to `false`.
 - `--hideInPageTOC<boolean>`<br>
   Do not render in-page table of contents items. Defaults to `false`.
-- `--hideMembersSymbol<boolean>`<br>
-  Do not add special symbols for class members. Defaults to `false`.
 - `--publicPath<string>`<br>
   Specify the base path for all urls. If undefined urls will be relative. Defaults to `.`.
 - `--namedAnchors<boolean>`<br>

packages/typedoc-plugin-markdown/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typedoc-plugin-markdown",
-  "version": "3.15.3",
+  "version": "3.15.4",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
   "main": "dist/index.js",
   "files": [

packages/typedoc-plugin-markdown/src/resources/helpers/comments.ts

@@ -3,25 +3,30 @@ import { Comment } from 'typedoc';
 import { camelToTitleCase } from '../../utils';
 
 export default function () {
-  Handlebars.registerHelper('comments', function (comment: Comment) {
-    const md: string[] = [];
+  Handlebars.registerHelper(
+    'comments',
+    function (comment: Comment, showSummary = true, showTags = true) {
+      const md: string[] = [];
 
-    if (comment.summary) {
-      md.push(Handlebars.helpers.comment(comment.summary));
-    }
+      if (showSummary && comment.summary) {
+        md.push(Handlebars.helpers.comment(comment.summary));
+      }
 
-    if (comment.blockTags?.length) {
-      const tags = comment.blockTags
-        .filter((tag) => tag.tag !== '@returns')
-        .map(
+      const filteredTags = comment.blockTags.filter(
+        (tag) => tag.tag !== '@returns',
+      );
+
+      if (showTags && comment.blockTags?.length) {
+        const tags = filteredTags.map(
           (tag) =>
             `**\`${camelToTitleCase(
               tag.tag.substring(1),
             )}\`**\n\n${Handlebars.helpers.comment(tag.content)}`,
         );
-      md.push(tags.join('\n\n'));
-    }
+        md.push(tags.join('\n\n'));
+      }
 
-    return md.join('\n\n');
-  });
+      return md.join('\n\n');
+    },
+  );
 }

packages/typedoc-plugin-markdown/src/resources/partials/member.signature.hbs

@@ -1,6 +1,14 @@
 {{{signatureTitle accessor}}}
 
-{{> comment}}
+{{#with comment}}
+
+{{#if hasVisibleComponent}}
+
+{{{comments this true false}}}
+
+{{/if}}
+
+{{/with}}
 
 {{#if typeParameters}}
 
@@ -96,6 +104,16 @@
 
 {{/ifShowReturns}}
 
+{{#with comment}}
+
+{{#if hasVisibleComponent}}
+
+{{{comments this false true}}}
+
+{{/if}}
+
+{{/with}}
+
 {{#if showSources}}
 
 {{> member.sources}}

packages/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap

@@ -23,8 +23,6 @@ exports[`Generics: should compile class with type params 1`] = `
 exports[`Generics: should compile function with a simple type param' 1`] = `
 "▸ **functionWithTypeParam**<\`A\`\\>(): \`boolean\`
 
-[partial: comment]
-
 ##### Type parameters
 
 | Name |

stub-project/src/comments.ts

@@ -108,3 +108,25 @@ export type literalWithBlockComments = {
    */
   prop: string;
 };
+
+/**
+ * Creates an integer expression for the end of an interval variable.
+ *
+ * @remarks
+ *
+ * If the interval is absent then the resulting expression is also absent.
+ *
+ * @example
+ *
+ * In the following example we constraint interval variable `y` to start after end of `y` with a delay at least 10. In addition we constrain length of `x` to be less or equal than length of `y`.
+ *
+ * ```ts
+ * let model = new CP.Model;
+ * ```
+ *
+ * When `x` or `y` is _absent_ then value of both constraints above is _absent_ and therefore they are satisfied.
+ *
+ */
+export function functionWithSummaryAndTags(arg: any) {
+  return '';
+}