Skip to content

Commit 4f343da

Browse files
authored
fix(docs): Fixed documentation inconsistencies: command formatting, syntax highlighting, and outdated references (#1016)
1 parent d95cf35 commit 4f343da

File tree

8 files changed

+13
-14
lines changed

8 files changed

+13
-14
lines changed

frontend/docs/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ us at [email protected].
100100

101101
## How do I report a bug in JSR?
102102

103-
> During the open beta, please email us at [email protected], or chat in the `#jsr`
104-
> channel on the Deno Discord (https://discord.gg/deno).
103+
> During the open beta, please email us at [email protected], or chat in the
104+
> [JSR Discord](https://discord.gg/hMqvhAn9xG).
105105
106106
Please open an issue on the JSR GitHub repository at
107107
[jsr-io/jsr](https://github.com/jsr-io/jsr).

frontend/docs/publishing-packages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,9 @@ registry.
260260

261261
```shell
262262
# deno
263-
$ deno publish --dry-run
263+
deno publish --dry-run
264264
# npm
265-
$ npx jsr publish --dry-run
265+
npx jsr publish --dry-run
266266
# yarn
267267
yarn dlx jsr publish --dry-run
268268
# pnpm
@@ -282,9 +282,9 @@ Enter the root directory of your package (containing the `jsr.json` /
282282

283283
```shell
284284
# deno
285-
$ deno publish
285+
deno publish
286286
# npm
287-
$ npx jsr publish
287+
npx jsr publish
288288
# yarn
289289
yarn dlx jsr publish
290290
# pnpm
@@ -433,7 +433,7 @@ because you have `"exports"` pointing to it (or a subdirectory of it). In this
433433
case, you can un-ignore the `dist/` directory by using a negation in the
434434
`exclude` field in your `jsr.json` / `deno.json` file.
435435

436-
```jsonc
436+
```json
437437
// jsr.json
438438
{
439439
"name": "@luca/greet",

frontend/docs/why.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ resource-constrained environments.
112112

113113
Your feedback will be critical to the success of JSR. If you have any ideas or
114114
feedback on how JSR could work better for your use case, please let us know on
115-
[Discord](https://discord.gg/deno) in either the `#jsr` or `#jsr-feedback`
116-
channels.
115+
[Discord](https://discord.gg/hMqvhAn9xG).
117116

118117
Ready to try JSR yourself? [Get started now](/docs/introduction).

frontend/docs/with/cloudflare-workers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Running `wrangler dev` to start the local development server will run your
4646
Cloudflare Worker. You can then visit `http://localhost:8787` to see the result.
4747

4848
```shell
49-
$ wrangler dev
49+
wrangler dev
5050
```
5151

5252
[Learn more about using packages.](/docs/using-packages)

frontend/docs/with/deno.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@ package. This command will display a list of all dependencies, including their
9191
version constraints.
9292

9393
```shell
94-
$ deno info jsr:@std/fs
94+
deno info jsr:@std/fs
9595
```

frontend/docs/with/nextjs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ application at `http://localhost:3000/`. You can then visit
4444
`http://localhost:3000/` to see it.
4545

4646
```shell
47-
$ next dev
47+
next dev
4848
```
4949

5050
[Learn more about using packages.](/docs/using-packages)

frontend/docs/with/node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ console.log(red("Hello, world!"));
3434
Running this code will print a red "Hello, world!" text to your terminal.
3535

3636
```shell
37-
$ node main.js
37+
node main.js
3838
```
3939

4040
[Learn more about using packages.](/docs/using-packages)

frontend/docs/with/vite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ at `http://localhost:5173`. You can then visit `http://localhost:5173` to see
4444
it.
4545

4646
```shell
47-
$ vite
47+
vite
4848
```
4949

5050
[Learn more about using packages.](/docs/using-packages)

0 commit comments

Comments
 (0)