We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Docs aren't fun, so I'm creating an epic to track all docs tasks in one place.
Some of these items came from the TODO list on #1297. I'd spent too long on #1297, so I wanted to merge it as-is and tackle these items in the future.
Refer to CommonJS / ESM consistently across all docs; link to common page explaining the difference
Refer to ts-node consistently; naming is inconsistent throughout the readme (implemented in changed all references to ts-node consistent #1481)
ts-node
remove "under construction" banner
Additions to "Troubleshooting" page
Revisit "shebang" (implemented by Docs overhaul #1682)
add "API" page to "Advanced" section (implemented by Docs overhaul #1682)
process.
Update "Ignored files" > "File extensions" to include mjs, mts, cts, cjs #1899
Add CONTRIBUTING.md docs about VSCode debugging #1499
Categorize API docs #1456
ignore option docs unclear; should point out they're regexps #1089
ignore
Fix createEsmHooks docs so they're not so ugly. Export proper type aliases for node's ESM loader hooks #1506
createEsmHooks
Tweak options docs to give each a header; draw inspiration from typedoc #1606
Add shiki-twoslash tooltips to docsite #1670
Prettier, categorized --help output #1674
Add json schema-powered shiki twoslash tooltips to docsite #1675
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Docs aren't fun, so I'm creating an epic to track all docs tasks in one place.
Some of these items came from the TODO list on #1297. I'd spent too long on #1297, so I wanted to merge it as-is and tackle these items in the future.
Refer to CommonJS / ESM consistently across all docs; link to common page explaining the difference
Refer to ts-node consistently; naming is inconsistent throughout the readme (implemented in changed all references to ts-node consistent #1481)
ts-node
(in backticks)remove "under construction" banner
Additions to "Troubleshooting" page
Revisit "shebang" (implemented by Docs overhaul #1682)
add "API" page to "Advanced" section (implemented by Docs overhaul #1682)
process.
Update "Ignored files" > "File extensions" to include mjs, mts, cts, cjs #1899
Add CONTRIBUTING.md docs about VSCode debugging #1499
Categorize API docs #1456
ignore
option docs unclear; should point out they're regexps #1089Fix
createEsmHooks
docs so they're not so ugly. Export proper type aliases for node's ESM loader hooks #1506Tweak options docs to give each a header; draw inspiration from typedoc #1606
Add shiki-twoslash tooltips to docsite #1670
Prettier, categorized --help output #1674
Add json schema-powered shiki twoslash tooltips to docsite #1675
The text was updated successfully, but these errors were encountered: