aboutsummaryrefslogtreecommitdiff
path: root/docs/nav.ts
diff options
context:
space:
mode:
authorGravatar Dylan Conway <dylan.conway567@gmail.com> 2023-10-14 12:58:30 -0700
committerGravatar Dylan Conway <dylan.conway567@gmail.com> 2023-10-14 12:58:30 -0700
commitf9add8b6bea4df3cdbd56a21f17e4cab1a854e4e (patch)
tree8e5306104d81c67b771181337bba02cd9ec39453 /docs/nav.ts
parent81a1a58d66c598ea35c42453d0ba4c6341a940fc (diff)
parent9b5e66453b0879ed77b71dcdbe50e4efa184261e (diff)
downloadbun-f9add8b6bea4df3cdbd56a21f17e4cab1a854e4e.tar.gz
bun-f9add8b6bea4df3cdbd56a21f17e4cab1a854e4e.tar.zst
bun-f9add8b6bea4df3cdbd56a21f17e4cab1a854e4e.zip
Merge branch 'main' into sdlsdl
Diffstat (limited to 'docs/nav.ts')
-rw-r--r--docs/nav.ts37
1 files changed, 29 insertions, 8 deletions
diff --git a/docs/nav.ts b/docs/nav.ts
index 2f9d74024..ccf3679fe 100644
--- a/docs/nav.ts
+++ b/docs/nav.ts
@@ -38,12 +38,13 @@ export default {
page("typescript", "TypeScript", {
description: "Install and configure type declarations for Bun's APIs",
}),
- page("templates", "Templates", {
- description: "Hit the ground running with one of Bun's official templates, or download a template from GitHub.",
+
+ divider("Templating"),
+ page("cli/init", "`bun init`", {
+ description: "Scaffold an empty Bun project.",
}),
- page("guides", "Guides", {
- description: "A set of walkthrough guides and code snippets for performing common tasks with Bun",
- href: "/guides",
+ page("cli/bun-create", "`bun create`", {
+ description: "Scaffold a new Bun project from an official template or GitHub repo.",
}),
// page("typescript", "TypeScript"),
@@ -81,7 +82,6 @@ export default {
// page("bundev", "Dev server"),
// page("benchmarks", "Benchmarks"),
- // divider("Runtime"),
divider("Runtime"),
page("cli/run", "`bun run`", {
description: "Use `bun run` to execute JavaScript/TypeScript files and package.json scripts.",
@@ -152,6 +152,21 @@ export default {
description:
"Install all dependencies with `bun install`, or manage dependencies with `bun add` and `bun remove`.",
}),
+ page("cli/add", "`bun add`", {
+ description: "Add dependencies to your project.",
+ }),
+ page("cli/remove", "`bun remove`", {
+ description: "Remove dependencies from your project.",
+ }),
+ page("cli/update", "`bun update`", {
+ description: "Update your project's dependencies.",
+ }),
+ page("cli/link", "`bun link`", {
+ description: "Install local packages as dependencies in your project.",
+ }),
+ page("cli/pm", "`bun pm`", {
+ description: "Utilities relating to package management with Bun.",
+ }),
page("install/cache", "Global cache", {
description:
"Bun's package manager installs all packages into a shared global cache to avoid redundant re-downloads.",
@@ -159,6 +174,9 @@ export default {
page("install/workspaces", "Workspaces", {
description: "Bun's package manager supports workspaces and mono-repo development workflows.",
}),
+ page("install/lifecycle", "Lifecycle scripts", {
+ description: "How Bun handles package lifecycle scripts with trustedDependencies",
+ }),
page("install/lockfile", "Lockfile", {
description:
"Bun's binary lockfile `bun.lockb` tracks your resolved dependency tree, making future installs fast and repeatable.",
@@ -166,9 +184,12 @@ export default {
page("install/registries", "Scopes and registries", {
description: "How to configure private scopes and custom package registries.",
}),
- page("install/utilities", "Utilities", {
- description: "Use `bun pm` to introspect your global module cache or project dependency tree.",
+ page("install/overrides", "Overrides and resolutions", {
+ description: "Specify version ranges for nested dependencies",
}),
+ // page("install/utilities", "Utilities", {
+ // description: "Use `bun pm` to introspect your global module cache or project dependency tree.",
+ // }),
divider("Bundler"),
page("bundler", "`Bun.build`", {