Reference Guide for my GitHub Project
Commands Overview#
| Command |
Type |
Description |
Example |
clone |
Command |
Clones a repository from GitHub. |
my-github-project clone <repo-url> |
generate |
Command |
Generates documentation from code comments. |
my-github-project generate |
serve |
Command |
Serves the generated documentation locally. |
my-github-project serve |
deploy |
Command |
Deploys documentation to GitHub Pages. |
my-github-project deploy |
Parameters for clone#
| Parameter |
Type |
Description |
Example |
<repo-url> |
String |
The URL of the GitHub repository to clone. |
https://github.com/user/repo.git |
--branch |
String |
Specify a branch to clone. |
--branch main |
--depth |
Integer |
Limit the clone to a specific number of commits. |
--depth 1 |
Parameters for generate#
| Parameter |
Type |
Description |
Example |
--output |
String |
Specify the output directory for generated docs. |
--output docs/ |
--format |
String |
Choose the format of the generated documentation. |
--format markdown |
Parameters for serve#
| Parameter |
Type |
Description |
Example |
--port |
Integer |
Specify the port to serve the documentation. |
--port 3000 |
--open |
Boolean |
Automatically open the documentation in a browser. |
--open |
Parameters for deploy#
| Parameter |
Type |
Description |
Example |
--branch |
String |
Specify the branch to deploy to GitHub Pages. |
--branch gh-pages |
--message |
String |
Commit message for the deployment. |
--message "Deploy docs" |
Use this reference guide to efficiently utilize my GitHub project for your documentation needs. Reduce manual writing and focus on coding.