@apify/docusaurus-plugin-typedoc-api 4.2.7 → 4.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,6 +5,8 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
5
5
  function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
6
6
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
7
7
  function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
8
+ const htmlEntities = require('html-entities');
9
+ const marked = require('marked');
8
10
  const Comment = require('./Comment.js');
9
11
  const Type = require('./Type.js');
10
12
  const jsxRuntime = require('react/jsx-runtime');
@@ -26,7 +28,15 @@ function DefaultValue({
26
28
  if (!comment && !value) {
27
29
  return null;
28
30
  }
29
- const defaultTag = extractDefaultTag(comment);
31
+ let defaultTag = extractDefaultTag(comment);
32
+ if (typeof defaultTag === 'string') {
33
+ defaultTag = htmlEntities.decode(marked.marked(defaultTag, {
34
+ // @ts-expect-error `marked`'s types are wrong
35
+ renderer: {
36
+ code: code => code
37
+ }
38
+ }));
39
+ }
30
40
  if (!defaultTag && !value) {
31
41
  return null;
32
42
  }
@@ -1 +1 @@
1
- {"version":3,"file":"DefaultValue.js","sources":["../../src/components/DefaultValue.tsx"],"sourcesContent":null,"names":["displayPartsToMarkdown","_jsxs","_jsx","_Fragment","Type"],"mappings":";;;;;;AAAA;AACA;AAIA,SAAS,iBAAiB,CAAC,OAAO,EAAE;AACpC,EAAE,MAAM,GAAG,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC;AACtE,EAAE,IAAI,CAAC,GAAG,EAAE;AACZ,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,OAAOA,8BAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AACM,SAAS,YAAY,CAAC;AAC7B,EAAE,OAAO;AACT,EAAE,KAAK;AACP,EAAE,IAAI;AACN,CAAC,EAAE;AACH,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAChD,EAAE,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE;AAC7B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,oBAAoBC,eAAK,CAAC,MAAM,EAAE;AACpC,IAAI,SAAS,EAAE,kDAAkD;AACjE,IAAI,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,iBAAiBC,cAAI,CAACC,mBAAS,EAAE;AAC5D,MAAM,QAAQ,EAAE,OAAO,KAAK,KAAK,QAAQ,GAAG,KAAK,gBAAgBD,cAAI,CAACE,SAAI,EAAE;AAC5E,QAAQ,IAAI,EAAE,KAAK;AACnB,OAAO,CAAC;AACR,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,UAAU,iBAAiBF,cAAI,CAACE,SAAI,EAAE;AACxD,MAAM,IAAI,EAAE;AACZ,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,IAAI,IAAI,EAAE,IAAI,KAAK,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC;AACnD,QAAQ,KAAK,EAAE,UAAU;AACzB,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;;;"}
1
+ {"version":3,"file":"DefaultValue.js","sources":["../../src/components/DefaultValue.tsx"],"sourcesContent":null,"names":["displayPartsToMarkdown","decode","marked","_jsxs","_jsx","_Fragment","Type"],"mappings":";;;;;;;;AAAA;AACA;AAMA,SAAS,iBAAiB,CAAC,OAAO,EAAE;AACpC,EAAE,MAAM,GAAG,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC;AACtE,EAAE,IAAI,CAAC,GAAG,EAAE;AACZ,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,OAAOA,8BAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AACM,SAAS,YAAY,CAAC;AAC7B,EAAE,OAAO;AACT,EAAE,KAAK;AACP,EAAE,IAAI;AACN,CAAC,EAAE;AACH,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,IAAI,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAC9C,EAAE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AACtC,IAAI,UAAU,GAAGC,mBAAM,CAACC,aAAM,CAAC,UAAU,EAAE;AAC3C;AACA,MAAM,QAAQ,EAAE;AAChB,QAAQ,IAAI,EAAE,IAAI,IAAI,IAAI;AAC1B,OAAO;AACP,KAAK,CAAC,CAAC,CAAC;AACR,GAAG;AACH,EAAE,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE;AAC7B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,oBAAoBC,eAAK,CAAC,MAAM,EAAE;AACpC,IAAI,SAAS,EAAE,kDAAkD;AACjE,IAAI,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,iBAAiBC,cAAI,CAACC,mBAAS,EAAE;AAC5D,MAAM,QAAQ,EAAE,OAAO,KAAK,KAAK,QAAQ,GAAG,KAAK,gBAAgBD,cAAI,CAACE,SAAI,EAAE;AAC5E,QAAQ,IAAI,EAAE,KAAK;AACnB,OAAO,CAAC;AACR,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,UAAU,iBAAiBF,cAAI,CAACE,SAAI,EAAE;AACxD,MAAM,IAAI,EAAE;AACZ,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,IAAI,IAAI,EAAE,IAAI,KAAK,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC;AACnD,QAAQ,KAAK,EAAE,UAAU;AACzB,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apify/docusaurus-plugin-typedoc-api",
3
- "version": "4.2.7",
3
+ "version": "4.2.8",
4
4
  "description": "Docusaurus plugin that provides source code API documentation powered by TypeDoc. ",
5
5
  "keywords": [
6
6
  "docusaurus",
@@ -47,6 +47,7 @@
47
47
  "@docusaurus/utils": "^3.5.2",
48
48
  "@types/react": "^18.3.11",
49
49
  "@vscode/codicons": "^0.0.35",
50
+ "html-entities": "2.3.2",
50
51
  "marked": "^9.1.6",
51
52
  "marked-smartypants": "^1.1.5",
52
53
  "typedoc": "^0.25.7",
@@ -1,5 +1,7 @@
1
1
  /* eslint-disable react-perf/jsx-no-new-object-as-prop */
2
2
 
3
+ import { decode } from 'html-entities';
4
+ import { marked } from 'marked';
3
5
  import type { JSONOutput } from 'typedoc';
4
6
  import { displayPartsToMarkdown } from './Comment';
5
7
  import { Type } from './Type';
@@ -25,7 +27,17 @@ export function DefaultValue({ comment, value, type }: DefaultValueProps) {
25
27
  return null;
26
28
  }
27
29
 
28
- const defaultTag = extractDefaultTag(comment);
30
+ let defaultTag = extractDefaultTag(comment);
31
+
32
+ if (typeof defaultTag === 'string') {
33
+ defaultTag = decode(marked(defaultTag, {
34
+ // @ts-expect-error `marked`'s types are wrong
35
+ renderer: {
36
+ code: (code: string) => code,
37
+ },
38
+ }));
39
+ }
40
+
29
41
 
30
42
  if (!defaultTag && !value) {
31
43
  return null;