Skip to content

Commit

Permalink
docs: use .md extension in links
Browse files Browse the repository at this point in the history
  • Loading branch information
privatenumber committed May 21, 2024
1 parent b54131c commit 52d696c
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Here are some notable ones I've found via [GitHub Search](https://github.com/sea

- **Watcher**

As a DX bonus, _tsx_ also comes with [Watch mode](/watch-mode) to help you iterate faster!
As a DX bonus, _tsx_ also comes with [Watch mode](/watch-mode.md) to help you iterate faster!

For a detailed technical comparison, you can refer to this [exhaustive comparison](https://github.com/privatenumber/ts-runtime-comparison) between `tsx`, `ts-node`, and other runtimes.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ tsx file.js

- Iterate on your code faster and boost productivity!

As a DX bonus, _tsx_ comes with a [watcher](/watch-mode) to re-run your files whenever you save them.
As a DX bonus, _tsx_ comes with a [watcher](/watch-mode.md) to re-run your files whenever you save them.

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion docs/node/cjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This section is only for adding tsx in CommonJS mode (doesn't affect `.mjs` or `
::: warning Not for 3rd-party packages
This enhances the entire runtime so it may not be suitable for loading TypeScript files from a 3rd-party package as it may lead to unexpected behavior in user code.

For importing TypeScript files in CommonJS mode without affecting the environment, see [`tsx.require()`](/node/tsx-require).
For importing TypeScript files in CommonJS mode without affecting the environment, see [`tsx.require()`](/node/tsx-require.md).
:::

## Command-line API
Expand Down
2 changes: 1 addition & 1 deletion docs/node/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This section is only for adding tsx in Module mode (doesn't affect `.cjs` or `.c
::: warning Not for 3rd-party packages
This enhances the entire runtime so it may not be suitable for loading TypeScript files from a 3rd-party package as it may lead to unexpected behavior in user code.

For importing TypeScript files in Module mode without affecting the environment, see the _Scoped registration_ section below or [`tsImport()`](/node/ts-import).
For importing TypeScript files in Module mode without affecting the environment, see the _Scoped registration_ section below or [`tsImport()`](/node/ts-import.md).
:::

## Command-line API
Expand Down
2 changes: 1 addition & 1 deletion docs/node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Node.js API is for advanced usage and should not be necessary for the majory

The Node.js API allows you to enhance Node with _tsx_ without directly running `tsx`. This is useful for adding TypeScript support to binaries (e.g. `eslint`), or to your 3rd-party package without affecting the environment (e.g. loading config files), or simply using `node` directly to reduce overhead.

Note, when using the Node.js integrations, CLI features such as [_Watch mode_](/watch-mode) will not be available.
Note, when using the Node.js integrations, CLI features such as [_Watch mode_](/watch-mode.md) will not be available.

## Global enhancement

Expand Down
2 changes: 1 addition & 1 deletion docs/node/ts-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const loaded = await tsImport('./file.ts', import.meta.url)
const loadedAgain = await tsImport('./file.ts', import.meta.url)

Check warning on line 24 in docs/node/ts-import.md

View workflow job for this annotation

GitHub Actions / Test (ubuntu-latest)

'loadedAgain' is assigned a value but never used

Check warning on line 24 in docs/node/ts-import.md

View workflow job for this annotation

GitHub Actions / Release

'loadedAgain' is assigned a value but never used
```
If you'd like to leverage module caching, see the [ESM scoped registration](/node/esm#scoped-registration) section.
If you'd like to leverage module caching, see the [ESM scoped registration](/node/esm.md#scoped-registration) section.
## CommonJS usage
Expand Down

0 comments on commit 52d696c

Please sign in to comment.