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.

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

docs: unify module pages #725

Merged
merged 16 commits into from
Sep 2, 2024
Merged

docs: unify module pages #725

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0334a37
docs: move modules page over
thisisjofrank Sep 2, 2024
06af857
fix: update links
thisisjofrank Sep 2, 2024
ea8a51e
docs: update freezing lockfiile section
marvinhagemeister Sep 2, 2024
0fd3d4c
docs: shorten module menu entry label
marvinhagemeister Sep 2, 2024
d4ebaba
docs: rework modules page
marvinhagemeister Sep 2, 2024
6e914c7
docs: move proxies section
marvinhagemeister Sep 2, 2024
c157cea
docs: update module page
marvinhagemeister Sep 2, 2024
a8b3ac1
fix: broken links
marvinhagemeister Sep 2, 2024
2f83a63
fix: fragment links
marvinhagemeister Sep 2, 2024
b4f7d57
chore: fix typo
marvinhagemeister Sep 2, 2024
0106afc
docs: apply phrasing suggestion
marvinhagemeister Sep 2, 2024
6f4d4c7
docs: apply review suggestions
marvinhagemeister Sep 2, 2024
5d56384
chore: apply suggestions
marvinhagemeister Sep 2, 2024
3082477
chore: fix typo
marvinhagemeister Sep 2, 2024
f7c0121
chore: apply suggestion
marvinhagemeister Sep 2, 2024
f78ada1
chore: fix formatting
marvinhagemeister Sep 2, 2024
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
Prev Previous commit
Next Next commit
docs: apply review suggestions 
Co-authored-by: Jo Franchetti <jofranchetti@gmail.com>
  • Loading branch information
@marvinhagemeister @thisisjofrank
marvinhagemeister and thisisjofrank authored Sep 2, 2024
commit 6f4d4c75912bdf6392a648cca4853f3771fa9308
12 changes: 4 additions & 8 deletions runtime/fundamentals/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ import { add } from "./calc.ts";

## Importing third party modules and libraries

Using third modules in Deno uses the same `import` syntax as your local code.
When working with third-party modules in Deno, use the same `import` syntax as you do for local code.
Third party modules are typically imported from a remote registry and start with
`jsr:` , `npm:` or `https://` for URL imports.

Expand All @@ -72,15 +72,11 @@ import { say } from "npm:cowsay@1.6.0";
import { pascalCase } from "https://deno.land/x/case/mod.ts";
```

You'll find most Deno-related code on [JSR](https://jsr.io), which is the
recommended registry to use with Deno.
Deno recommends [JSR](https://jsr.io), the modern JavaScript registry, for third party modules. There, you'll find plenty of well documented ES modules for your projects, including the [Deno Standard Library](/runtime/fundamentals/standard_library/).

## Managing third party modules and libraries

Typing out the module with the full version specifier can become tedious real
fast when you're importing them from multiple files. We can centralize the
management of remote modules via the `imports` key in `deno.json`. The `imports`
key is used to remap specifiers. We call this the import map.
Typing out the module name with the full version specifier can become tedious when importing them in multiple files. You can centralize management of remote modules with an `imports` field in your `deno.json` file. We call this `imports` field the **import map**.

```json title="deno.json"
{
Expand All @@ -92,7 +88,7 @@ key is used to remap specifiers. We call this the import map.
}
```

With the remapped specifiers our code gets a bit simpler:
With remapped specifiers, the code looks cleaner:

```ts title="main.ts"
import { camelCase } from "@luca/cases";
Expand Down
Loading