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

Reformat "options" section of README into a table #1222

Closed
cspotcode opened this issue Feb 15, 2021 · 1 comment
Closed

Reformat "options" section of README into a table #1222

cspotcode opened this issue Feb 15, 2021 · 1 comment
Milestone

Comments

@cspotcode
Copy link
Collaborator

Unify CLI, env var, and programmatic options into a table.

Something like this:

| CLI | Environment | API | Description |
|---|---|---|---|
| `-T, --transpile-only` | `TS_NODE_TRANSPILE_ONLY` | `transpileOnly` | Use TypeScript's faster `transpileModule` (default: `false`) |

Renders like:

CLI Environment API Description
-T, --transpile-only TS_NODE_TRANSPILE_ONLY transpileOnly Use TypeScript's faster transpileModule (default: false)
@cspotcode
Copy link
Collaborator Author

I tried this in #1297 but nothing looked quite right, so I ended up staying with a bulleted list like we have today. Maybe I'll revisit in the future.

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 a pull request may close this issue.

1 participant