paseto/typedoc.json at main · panva/paseto · 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
82
83
84
85
86
87
88
89
{
  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
  "logLevel": "Warn",
  "treatWarningsAsErrors": true,
  "disableSources": true,
  "hideBreadcrumbs": true,
  "visibilityFilters": {
    "protected": false,
    "private": false,
    "inherited": true,
    "external": false
  },
  "includeVersion": false,
  "entryPoints": [
    "index.ts",
    "v1/local.ts",
    "v1/public.ts",
    "v2/local.ts",
    "v2/public.ts",
    "v3/local.ts",
    "v3/public.ts",
    "v4/local.ts",
    "v4/public.ts"
  ],
  "excludeExternals": true,
  "excludePrivate": true,
  "excludeProtected": true,
  "intentionallyNotExported": [
    "ClaimsInput",
    "CryptoKeyStructuralFallback",
    "LocalCapabilityMethod",
    "PublicCapabilityMethod"
  ],
  "gitRevision": "main",
  "hideGenerator": true,
  "out": "docs",
  "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-remark", "./docs-theme.ts"],
  "readme": "none",
  "sort": ["kind", "static-first", "required-first", "alphabetical"],
  "categoryOrder": [
    "Protocol Composition",
    "Local Implementations",
    "Public Implementations",
    "Local Token Operations",
    "Local Key Management",
    "Local Key Wrapping",
    "Public Token Operations",
    "Public Key Management",
    "Public Key Wrapping",
    "Token Operations",
    "Key Management",
    "CryptoKey Adapters",
    "Key Wrapping",
    "Password-Based Key Wrapping",
    "Key Sealing",
    "Tokens and Claims",
    "Keys",
    "PASERK Serializations",
    "Utilities",
    "Errors"
  ],
  "githubPages": false,
  "parametersFormat": "table",
  "indexFormat": "table",
  "hidePageHeader": true,
  "expandObjects": false,
  "expandParameters": false,
  "interfacePropertiesFormat": "list",
  "tableColumnSettings": {
    "hideDefaults": true,
    "hideInherited": false,
    "hideModifiers": false,
    "hideOverrides": false,
    "hideSources": false,
    "hideValues": false,
    "leftAlignHeaders": true
  },
  "theme": "my-markdown",
  "remarkStringifyOptions": { "bullet": "-" },
  "remarkPlugins": [
    {
      "applyTo": ["Class", "Interface"],
      "plugins": [
        ["remark-insert-headings", { "text": "Contents" }],
        ["remark-toc", { "maxDepth": 3, "skip": "Extends|See|Example" }]
      ]
    }
  ]
}