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

Add heading level to markdown option #217

Open
breyed opened this issue Feb 6, 2022 · 0 comments
Open

Add heading level to markdown option #217

breyed opened this issue Feb 6, 2022 · 0 comments

Comments

@breyed
Copy link

breyed commented Feb 6, 2022

Feature suggestion: For the --markdown option, add a heading level after it. Use 2 (the existing heading level) as the default.

This will allow projects that include an envinfo report in their issues to integrate the formatting with the rest of the issue formatting. For example, the NextAuth.js bug template, which places the report in a section with heading level 3, would direct contributors to run envinfo with heading level 4:

npx envinfo --system --binaries --browsers --npmPackages "next,next-auth,react" --markdown 4

The markdown would emit a number of "#"s according to the heading level. In the NextAuth.js example:

#### System:
 - OS: macOS 12.2
 - CPU: (8) x64 Intel(R) Core(TM) i7-1068NG7 CPU @ 2.30GHz
 - Memory: 511.94 MB / 16.00 GB
 - Shell: 5.8 - /bin/zsh
#### Binaries:
 - Node: 16.13.2 - /usr/local/bin/node
 - Yarn: 1.22.15 - /usr/local/bin/yarn
 - npm: 8.4.1 - /usr/local/bin/npm
#### Browsers:
 - Chrome: 98.0.4758.80
 - Safari: 15.3
#### npmPackages:
 - next: ^12.0.10 => 12.0.10 
 - next-auth: ^4.2.1 => 4.2.1 
 - react: ^17.0.2 => 17.0.2 
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

No branches or pull requests

1 participant