mathlive/typedoc.json at master · arnog/mathlive · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{
  // https://typedoc.org/options/
  "categoryOrder": [
    "Mathfield",
    "Accessing and changing the content", // Secondary category
    "Selection",
    "Customization", // Secondary category
    "Styles",
    "Options",
    "Macros",
    "Registers",
    "Editing Commands",
    "Speech",

    "Focus", // Secondary category

    "Prompts", // Secondary category
    "Undo", // Secondary category

    "Keyboard Shortcuts", // Secondary category
    "Menu", // Secondary category
    "Virtual Keyboard",

    "Localization", // Secondary category

    "Static Rendering",
    "Conversion",

    "MathJSON",
    "Other",
    "*"
  ],

  "out": "./temp-docs",
  "compilerOptions": {
    // "esModuleInterop": true,

    // More lenient...
    "noImplicitAny": false,
    "strictNullChecks": false
  },
  // "includes": "./src/compute-engine/**/*",
  "externalPattern": ["**/node_modules/**"],
  "excludeInternal": true,
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeReferences": true,
  "name": "Mathfield API Reference",
  "disableSources": true,
  "disableGit": true,
  "outputFileStrategy": "modules",
  "entryPoints": ["./src/mathlive.ts"],
  "readme": "none",
  "excludeExternals": true,

  // https://typedoc-plugin-markdown.org/options
  "plugin": [
    // "typedoc-plugin-no-inherit",
    "typedoc-plugin-markdown",
    "./plugins/grok-theme/index.mjs"
  ],
  "theme": "grok-theme",
  "useHTMLAnchors": true,
  "hidePageHeader": true,
  "hidePageTitle": true,
  "hideBreadcrumbs": true,
  "excludeGroups": true,
  "useCodeBlocks": true, // Use code blocks for function signatures
  "expandParameters": false, // Don't include type in function signatures
  "parametersFormat": "list", // table | list
  "propertiesFormat": "list", // table | list
  "typeDeclarationFormat": "list", // table | list
  "expandObjects": true,
  "notRenderedTags": [
    "@noInheritDoc",
    "@keywords",
    "@command",
    "@category",
    "@version"
  ]
}