Skip to content

Update README to use correct generation command for tsconfig-references #3397

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Update README to use correct generation command for tsconfig-references #3397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ A set of tools and scripts for generating a comprehensive API reference for the

```sh
# Generate JSON from the typescript cli
pnpm run --filter=tsconfig-reference generate-json
pnpm run --filter=tsconfig-reference generate:json
# Jams them all into a single file
pnpm run --filter=tsconfig-reference generate-markdown
pnpm run --filter=tsconfig-reference generate:md
```

Validate the docs:
Expand Down
4 changes: 2 additions & 2 deletions packages/glossary/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ The TSConfig reference is created by a two step process:
You can run these commands from the root of the repo:

```sh
pnpm run --filter=tsconfig-reference generate-json
pnpm run --filter=tsconfig-reference generate:json

pnpm run --filter=tsconfig-reference generate-markdown
pnpm run --filter=tsconfig-reference generate:md
```

You can validate any codeblocks which use twoslash via the script:
Expand Down
4 changes: 2 additions & 2 deletions packages/tsconfig-reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ The TSConfig reference is created by a two step process:
You can run these commands from the root of the repo:

```sh
pnpm run --filter=tsconfig-reference generate-json
pnpm run --filter=tsconfig-reference generate:json

pnpm run --filter=tsconfig-reference generate-markdown
pnpm run --filter=tsconfig-reference generate:md
```

You can validate any codeblocks which use twoslash via the script:
Expand Down