Skip to content

Commit

Permalink
docs: initial documentation for undocumented commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Lee-W committed May 15, 2024
1 parent 9308cd7 commit 3e57007
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 5 deletions.
5 changes: 5 additions & 0 deletions docs/commands/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Show commit example

## Usage

![cz example --help](../images/cli_help/cz_example___help.svg)
5 changes: 5 additions & 0 deletions docs/commands/info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Show information about the cz

## Usage

![cz info --help](../images/cli_help/cz_info___help.svg)
3 changes: 3 additions & 0 deletions docs/commands/ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Usage

![cz ls --help](../images/cli_help/cz_ls___help.svg)
5 changes: 5 additions & 0 deletions docs/commands/schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Show commit schema

## Usage

![cz schema --help](../images/cli_help/cz_schema___help.svg)
5 changes: 5 additions & 0 deletions docs/commands/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Get the version of the installed commitizen or the current project (default: installed commitizen)

## Usage

![cz version --help](../images/cli_help/cz_version___help.svg)
15 changes: 10 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,16 @@ nav:
- Introduction: "README.md"
- Getting Started: "getting_started.md"
- Commands:
- Init: "commands/init.md"
- Commit: "commands/commit.md"
- Bump: "commands/bump.md"
- Check: "commands/check.md"
- Changelog: "commands/changelog.md"
- init: "commands/init.md"
- commit: "commands/commit.md"
- bump: "commands/bump.md"
- check: "commands/check.md"
- changelog: "commands/changelog.md"
- example: "commands/example.md"
- info: "commands/info.md"
- ls: "commands/ls.md"
- schema: "commands/schema.md"
- version: "commands/version.md"
- Configuration: "config.md"
- Customization: "customization.md"
- Tutorials:
Expand Down

0 comments on commit 3e57007

Please sign in to comment.