transmissions/jsdoc.json at main · danja/transmissions · 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
{
    "source": {
        "include": [
            "src",
            "README.md"
        ],
        "exclude": [
            "src/node_modules",
            "src/applications/*/data",
            "src/tools/nodeflow/samples",
            "**/node_modules/**",
            "**/test/**",
            "**/tests/**",
            "**/spec/**",
            "**/examples/**"
        ],
        "includePattern": "\\.(js|mjs|jsx|ts|tsx|md)$",
        "excludePattern": "(^|\\/|\\\\)(_|test|spec|copy|example|samples?)"
    },
    "opts": {
        "template": "node_modules/better-docs",
        "destination": "./docs/jsdoc",
        "readme": "README.md",
        "recurse": true,
        "verbose": true,
        "tutorials": "./docs/jsdoc-tutorials"
    },
    "plugins": [
        "plugins/markdown",
        "better-docs/category",
        "better-docs/component"
    ],
    "templates": {
        "better-docs": {
            "name": "Transmissions Framework",
            "title": "Transmissions - Dataflow Processing Framework",
            "navigation": [
                {
                    "label": "GitHub",
                    "href": "https://github.com/danja/transmissions"
                }
            ]
        },
        "search": true
    },
    "markdown": {
        "parser": "gfm",
        "hardwrap": false
    },
    "tags": {
        "allowUnknownTags": [
            "category",
            "component",
            "namespace",
            "memberof"
        ]
    }
}