Skip to content

Commit 8015562

Browse files
committed
Make inputs/outputs subsections in README
1 parent cde6336 commit 8015562

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ For a full demo, check out the [githubocto/repo-visualizer-demo](https://github.
88

99
## Inputs
1010

11-
## `output_file`
11+
### `output_file`
1212

1313
A path (relative to the root of your repo) to where you would like the diagram to live.
1414

1515
For example: images/diagram.svg
1616

1717
Default: diagram.svg
1818

19-
## `excluded_paths`
19+
### `excluded_paths`
2020

2121
A list of paths to folders to exclude from the diagram, separated by commas.
2222

2323
For example: dist,node_modules
2424

2525
Default: node_modules,bower_components,dist,out,build,eject,.next,.netlify,.yarn,.vscode,package-lock.json,yarn.lock
2626

27-
## `excluded_globs`
27+
### `excluded_globs`
2828

2929
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.
3030

@@ -38,41 +38,41 @@ excluded_globs: 'frontend/*.spec.js;**/*.{png,jpg};**/!(*.module).ts'
3838
# - '**/!(*.module).ts' # all TS files except module files
3939
```
4040

41-
## `root_path`
41+
### `root_path`
4242

4343
The directory (and its children) that you want to visualize in the diagram, relative to the repository root.
4444

4545
For example: `src/`
4646

4747
Default: `''` (current directory)
4848

49-
## `max_depth`
49+
### `max_depth`
5050

5151
The maximum number of nested folders to show files within. A higher number will take longer to render.
5252

5353
Default: 9
5454

55-
## `push`
55+
### `push`
5656

5757
Whether to make a new commit with the diagram and push it to the original repository.
5858

5959
Should be a boolean value, i.e. `true` or `false`. See `commit_message` and `branch` for how to customise the commit.
6060

6161
Default: `false`
6262

63-
## `commit_message`
63+
### `commit_message`
6464

6565
The commit message to use when updating the diagram. Useful for skipping CI. For example: `Updating diagram [skip ci]`
6666

6767
Default: `Repo visualizer: updated diagram`
6868

69-
## `branch`
69+
### `branch`
7070

7171
The branch name to push the diagram to (branch will be created if it does not yet exist).
7272

7373
For example: `diagram`
7474

75-
## `artifact_name`
75+
### `artifact_name`
7676

7777
The name of an [artifact](https://docs.github.com/en/actions/guides/storing-workflow-data-as-artifacts) to create containing the diagram.
7878

@@ -82,7 +82,7 @@ Default: `''` (no artifact)
8282

8383
## Outputs
8484

85-
## `svg`
85+
### `svg`
8686

8787
The contents of the diagram as text. This can be used if you don't want to handle new files.
8888

0 commit comments

Comments
 (0)