Skip to content

Commit 3e57007

Browse files
committed
docs: initial documentation for undocumented commands
1 parent 9308cd7 commit 3e57007

File tree

6 files changed

+33
-5
lines changed

6 files changed

+33
-5
lines changed

docs/commands/example.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Show commit example
2+
3+
## Usage
4+
5+
![cz example --help](../images/cli_help/cz_example___help.svg)

docs/commands/info.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Show information about the cz
2+
3+
## Usage
4+
5+
![cz info --help](../images/cli_help/cz_info___help.svg)

docs/commands/ls.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Usage
2+
3+
![cz ls --help](../images/cli_help/cz_ls___help.svg)

docs/commands/schema.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Show commit schema
2+
3+
## Usage
4+
5+
![cz schema --help](../images/cli_help/cz_schema___help.svg)

docs/commands/version.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Get the version of the installed commitizen or the current project (default: installed commitizen)
2+
3+
## Usage
4+
5+
![cz version --help](../images/cli_help/cz_version___help.svg)

mkdocs.yml

+10-5
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,16 @@ nav:
3333
- Introduction: "README.md"
3434
- Getting Started: "getting_started.md"
3535
- Commands:
36-
- Init: "commands/init.md"
37-
- Commit: "commands/commit.md"
38-
- Bump: "commands/bump.md"
39-
- Check: "commands/check.md"
40-
- Changelog: "commands/changelog.md"
36+
- init: "commands/init.md"
37+
- commit: "commands/commit.md"
38+
- bump: "commands/bump.md"
39+
- check: "commands/check.md"
40+
- changelog: "commands/changelog.md"
41+
- example: "commands/example.md"
42+
- info: "commands/info.md"
43+
- ls: "commands/ls.md"
44+
- schema: "commands/schema.md"
45+
- version: "commands/version.md"
4146
- Configuration: "config.md"
4247
- Customization: "customization.md"
4348
- Tutorials:

0 commit comments

Comments
 (0)