-
Notifications
You must be signed in to change notification settings - Fork 179
Expand file tree
/
Copy pathconfig.js
More file actions
50 lines (47 loc) · 2.02 KB
/
config.js
File metadata and controls
50 lines (47 loc) · 2.02 KB
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
// SPDX-FileCopyrightText: the secureCodeBox authors
//
// SPDX-License-Identifier: Apache-2.0
const docsConfig = {
repository: "secureCodeBox/secureCodeBox", // The repository url without the github part of the link
targetPath: "docs", // This needs to be 'docs' for the docusaurus build, but you may specify a 'docs/<subdirectory>'
sizeLimit: 500000, // Limit of file size, most importantly used for large findings.
findingsDir: "findings", // Directory for large findings which exceeded sizeLimit
branch: "main",
// Configures files which will be copied or generated from docsConfig.repository.
// This is an array of maps.
//
// The map has the properties:
//
// src: required source directory in main repository (docsConfig.repository).
// dst: required target directory in this repository relative to config.targetPath.
// exclude: (optional) array of files to exclude from src, default is exclude nothing.
// keep: (optional) array of files to keep in dst, default is keep nothing (all files ending with .md will
// be wiped from dst.
//
// Example:
// filesFromRepository: [
// {src: "foo", dst: "some/foo", exclude: ["snafu.md", "susfu.md"]},
// {src: "bar", dst: "some/bar"},
// {src: "bar", dst: "some/bar", keep: ["index.md"]},
// ]
filesFromRepository: [
{
src: "scanners",
dst: "scanners",
},
{
src: "hooks",
dst: "hooks",
},
],
},
// This is to configure what to show at the homepage tile-view.
integrationsConfig = {
targetFile: "src/integrations.js", // Name of the target file to (over-)write
integrationDirs: ["hooks", "scanners"], // Names of the directories relative to the root level of the `/docs` folder
defaultIcon: "img/integrationIcons/Default.svg", // Default Icon when no imageUrl provided or could not resolve imageUrl
};
module.exports = {
docsConfig,
integrationsConfig,
};