@@ -8,23 +8,23 @@ For a full demo, check out the [githubocto/repo-visualizer-demo](https://github.
8
8
9
9
## Inputs
10
10
11
- ## ` output_file `
11
+ ### ` output_file `
12
12
13
13
A path (relative to the root of your repo) to where you would like the diagram to live.
14
14
15
15
For example: images/diagram.svg
16
16
17
17
Default: diagram.svg
18
18
19
- ## ` excluded_paths `
19
+ ### ` excluded_paths `
20
20
21
21
A list of paths to folders to exclude from the diagram, separated by commas.
22
22
23
23
For example: dist,node_modules
24
24
25
25
Default: node_modules,bower_components,dist,out,build,eject,.next,.netlify,.yarn,.vscode,package-lock.json,yarn.lock
26
26
27
- ## ` excluded_globs `
27
+ ### ` excluded_globs `
28
28
29
29
A semicolon-delimited array of file [ globs] ( https://globster.xyz/ ) to exclude from the diagram, using [ micromatch] ( https://github.com/micromatch/micromatch ) syntax. Provided as an array.
30
30
@@ -38,41 +38,41 @@ excluded_globs: 'frontend/*.spec.js;**/*.{png,jpg};**/!(*.module).ts'
38
38
# - '**/!(*.module).ts' # all TS files except module files
39
39
```
40
40
41
- ## ` root_path `
41
+ ### ` root_path `
42
42
43
43
The directory (and its children) that you want to visualize in the diagram, relative to the repository root.
44
44
45
45
For example: ` src/ `
46
46
47
47
Default: ` '' ` (current directory)
48
48
49
- ## ` max_depth `
49
+ ### ` max_depth `
50
50
51
51
The maximum number of nested folders to show files within. A higher number will take longer to render.
52
52
53
53
Default: 9
54
54
55
- ## ` push `
55
+ ### ` push `
56
56
57
57
Whether to make a new commit with the diagram and push it to the original repository.
58
58
59
59
Should be a boolean value, i.e. ` true ` or ` false ` . See ` commit_message ` and ` branch ` for how to customise the commit.
60
60
61
61
Default: ` false `
62
62
63
- ## ` commit_message `
63
+ ### ` commit_message `
64
64
65
65
The commit message to use when updating the diagram. Useful for skipping CI. For example: ` Updating diagram [skip ci] `
66
66
67
67
Default: ` Repo visualizer: updated diagram `
68
68
69
- ## ` branch `
69
+ ### ` branch `
70
70
71
71
The branch name to push the diagram to (branch will be created if it does not yet exist).
72
72
73
73
For example: ` diagram `
74
74
75
- ## ` artifact_name `
75
+ ### ` artifact_name `
76
76
77
77
The name of an [ artifact] ( https://docs.github.com/en/actions/guides/storing-workflow-data-as-artifacts ) to create containing the diagram.
78
78
@@ -82,7 +82,7 @@ Default: `''` (no artifact)
82
82
83
83
## Outputs
84
84
85
- ## ` svg `
85
+ ### ` svg `
86
86
87
87
The contents of the diagram as text. This can be used if you don't want to handle new files.
88
88
0 commit comments