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

New generate docs output style #15

Open
3 tasks done
ntnyq opened this issue Nov 23, 2024 · 1 comment
Open
3 tasks done

New generate docs output style #15

ntnyq opened this issue Nov 23, 2024 · 1 comment
Labels
enhancement New feature or request pr welcome

Comments

@ntnyq
Copy link

ntnyq commented Nov 23, 2024

Clear and concise description of the problem

Table would be not good looking when content is a bit long.

Suggested solution

Commands

command title 1

  • Command: ext.command1

command title 2

  • Command: ext.command2

Configs

config key 1

  • Type: string
  • Default: false
  • Required: false

Config description.

config key 2

  • Type: number
  • Default: 0
  • Required: true

Config description long long long long long long long long long long long long long long long long long long.

With this style, we can add more json schema content if necessary.

Alternative

No response

Additional context

No response

Validations

@ntnyq ntnyq added the enhancement New feature or request label Nov 23, 2024
@antfu
Copy link
Owner

antfu commented Nov 26, 2024

We could have a flag, or we could have both <!-- configs-list --> and <!-- configs-table --> and let users to choose. PR welcome :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pr welcome
Projects
None yet
Development

No branches or pull requests

2 participants