docs: add bun commands to getting started guide (#188)

biomejs · Sep 8, 2023 · f9b458f · f9b458f
1 parent 5828737
commit f9b458f
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 1 deletion.
diff --git a/website/src/assets/svg/bun.svg b/website/src/assets/svg/bun.svg
diff --git a/website/src/components/PackageManagerCommand.astro b/website/src/components/PackageManagerCommand.astro
@@ -18,8 +18,13 @@ import InlineSVG from "@src/components/InlineSVG.astro";
     <InlineSVG src="pnpm" />
     <span>pnpm</span>
   </li>
+  <li data-name="bun">
+    <InlineSVG src="bun" />
+    <span>bun</span>
+  </li>
 </ul>
 
 <pre data-name="npm" class="package-manager-command language-shellsession active"><code>{Astro.props.npx ? "npx" : "npm"} {Astro.props.npx ?? Astro.props.npm ?? Astro.props.command}</code></pre>
 <pre data-name="yarn" class="package-manager-command language-shellsession"><code>yarn {Astro.props.yarn ?? Astro.props.command}</code></pre>
 <pre data-name="pnpm" class="package-manager-command language-shellsession"><code>pnpm {Astro.props.pnpm ?? Astro.props.command}</code></pre>
+<pre data-name="bun" class="package-manager-command language-shellsession"><code>bun{Astro.props.bun ? "" : "x"} {Astro.props.bunx ?? Astro.props.bun ?? Astro.props.command}</code></pre>
diff --git a/website/src/components/PackageManagerRomeCommand.astro b/website/src/components/PackageManagerRomeCommand.astro
@@ -4,4 +4,4 @@ let {command} = Astro.props;
 command = `biome ${command}`;
 ---
 
-<PackageManagerCommand yarn={command} pnpm={command} npx={command} />
+<PackageManagerCommand yarn={command} pnpm={command} npx={command} bunx={command} />
diff --git a/website/src/content/docs/guides/getting-started.mdx b/website/src/content/docs/guides/getting-started.mdx
@@ -24,6 +24,7 @@ To install Biome, run the following commands in a directory containing a `packag
   npm="install --save-dev --save-exact @biomejs/biome"
   pnpm="add --save-dev --save-exact @biomejs/biome"
   yarn="add --dev --exact @biomejs/biome"
+  bun="add --dev --exact @biomejs/biome"
 />
 
 > **Note**: It is also possible to install Biome globally rather than locally.