Skip to content

Commit

Permalink
[docs] fix module links (#2676)
Browse files Browse the repository at this point in the history
* Fix link anchor

* docs: more module link fixes

Co-authored-by: bluwy <bjornlu.dev@gmail.com>
  • Loading branch information
cbenz and bluwy authored Oct 25, 2021
1 parent 8110aa0 commit 73658c5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/12-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Packaging

You can use SvelteKit to build component libraries as well as apps.

When you're creating an app, the contents of `src/routes` is the public-facing stuff; [`src/lib`](#modules-lib) contains your app's internal library.
When you're creating an app, the contents of `src/routes` is the public-facing stuff; [`src/lib`](#modules-$lib) contains your app's internal library.

A SvelteKit component library has the exact same structure as a SvelteKit app, except that `src/lib` is the public-facing bit. `src/routes` might be a documentation or demo site that accompanies the library, or it might just be a sandbox you use during development.

Expand Down
4 changes: 2 additions & 2 deletions documentation/migrating/03-project-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This file also has no direct equivalent, since SvelteKit apps can run in serverl

### src/service-worker.js

Most imports from `@sapper/service-worker` have equivalents in [`$service-worker`](/docs#modules-service-worker):
Most imports from `@sapper/service-worker` have equivalents in [`$service-worker`](/docs#modules-$service-worker):

- `timestamp` is unchanged
- `files` is unchanged
Expand All @@ -39,4 +39,4 @@ The `<div id="sapper">` is no longer necessary, though you can continue mounting

### src/node_modules

A common pattern in Sapper apps is to put your internal library in a directory inside `src/node_modules`. This doesn't work with Vite, so we use [`src/lib`](/docs#modules-lib) instead.
A common pattern in Sapper apps is to put your internal library in a directory inside `src/node_modules`. This doesn't work with Vite, so we use [`src/lib`](/docs#modules-$lib) instead.
4 changes: 2 additions & 2 deletions documentation/migrating/04-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Your custom error page component should be renamed from `_error.svelte` to `__er

### Imports

The `goto`, `prefetch` and `prefetchRoutes` imports from `@sapper/app` should be replaced with identical imports from [`$app/navigation`](/docs#modules-app-navigation).
The `goto`, `prefetch` and `prefetchRoutes` imports from `@sapper/app` should be replaced with identical imports from [`$app/navigation`](/docs#modules-$app-navigation).

The `stores` import from `@sapper/app` should be replaced — see the [Stores](#pages-and-layouts-stores) section below.

Any files you previously imported from directories in `src/node_modules` will need to be replaced with [`$lib`](/docs#modules-lib) imports.
Any files you previously imported from directories in `src/node_modules` will need to be replaced with [`$lib`](/docs#modules-$lib) imports.

### Preload

Expand Down

0 comments on commit 73658c5

Please sign in to comment.