docs: add commit cli

12rambau · Lee-W · commit 4e085241982e · 2023-01-22T19:18:06.000+08:00
diff --git a/.DS_Store b/.DS_Store
diff --git a/docs/commit.md b/docs/commit.md
@@ -0,0 +1,11 @@
+![Using commitizen cli](images/demo.gif)
+
+## About
+
+In your terminal run `cz commit` or the shortcut `cz c` to generate a guided git commit.
+
+A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`.
+
+!!! note
+    To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
+    In particular pre-commit hooks coloring will be deactivated.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,6 +12,7 @@ nav:
     - Introduction: 'README.md'
     - Commands:
         - Init: 'init.md'
+        - Commit: 'commit.md'
         - Bump: 'bump.md'
         - Check: 'check.md'
         - Changelog: 'changelog.md'
