Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: markdown docs generator #73

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat: markdown docs generator #73

wants to merge 10 commits into from

Conversation

ps-kwang
Copy link
Contributor

Adds a markdown generator to the docs.

@@ -0,0 +1,228 @@
// deno-lint-ignore-file no-explicit-any
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is forked to fix a bug: jaredLunde/zcli#20

| `max` | | The maximum number of active machines in the autoscaling group | true |
| `min` | | The minimum number of active machines in the autoscaling group | true |
| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false |
| `log-level` | l | Enable debug logging. | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Enable debug logging"
(no dot) same for fields. "The fields to include in the response"

| Name | Aliases | Description | Required |
| -------------- | ------- | ------------------------------------------------------------ | -------- |
| `limit` | | The number of items to return in the next page. | false |
| `after` | | The cursor to fetch the next results from. | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

limit and after too

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

machine-type


| Subcommand | Description |
| ---------- | ------------------------------------------------------ |
| `bash` | Generate the autocompletion script for the bash shell. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bash too


| Subcommand | Description |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `delete` | Delete a configuration value. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete

| `delete` | Delete a custom template from a team. |
| `get` | Get a custom template from a team. |
| `help` | Show help for a custom-template command |
| `list` | List custom templates in your team. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get

| `desc` | | Whether to order items descending. | false |
| `fields` | F | The fields to include in the response. | false |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

asc, desc

| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `limit` | | The number of items to return in the next page. | false |
| `after` | | The cursor to fetch the next results from. | false |
| `orderBy` | | The field to order items by. | false |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

orderBy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants