+
+
+
+
diff --git a/src/components/guides/development-workflow/CICheckSnippet.astro b/src/components/guides/development-workflow/CICheckSnippet.astro
index 4594c388..8c7d7b77 100644
--- a/src/components/guides/development-workflow/CICheckSnippet.astro
+++ b/src/components/guides/development-workflow/CICheckSnippet.astro
@@ -1,5 +1,5 @@
---
-import { Code } from '@astrojs/starlight/components';
+import { Code } from 'starlight-theme-nova/components';
const code = `
name: ci
diff --git a/src/components/icons/tabler-moon-filled.svg b/src/components/icons/tabler-moon-filled.svg
new file mode 100644
index 00000000..e4ae8b43
--- /dev/null
+++ b/src/components/icons/tabler-moon-filled.svg
@@ -0,0 +1 @@
+
diff --git a/src/components/icons/tabler-sun-high-filled.svg b/src/components/icons/tabler-sun-high-filled.svg
new file mode 100644
index 00000000..aa847e0f
--- /dev/null
+++ b/src/components/icons/tabler-sun-high-filled.svg
@@ -0,0 +1 @@
+
diff --git a/src/content/docs/code-push/ci/generic.mdx b/src/content/docs/code-push/ci/generic.mdx
index e59cc338..e2d45e36 100644
--- a/src/content/docs/code-push/ci/generic.mdx
+++ b/src/content/docs/code-push/ci/generic.mdx
@@ -9,6 +9,7 @@ sidebar:
{/* cspell:words proto tlsv codemagic */}
import Authentication from './_authentication.mdx';
+import { LinkCard } from 'starlight-theme-nova/components';
Building with Shorebird in CI should be a very small change from your existing
Flutter CI builds. Changes required:
@@ -18,13 +19,21 @@ Flutter CI builds. Changes required:
3. Replacing `flutter build --release` with `shorebird release` or
`shorebird patch`.
-We have detailed instructions for integrating into
-
-- [GitHub](/code-push/ci/github)
-- [Codemagic](/code-push/ci/codemagic)
-
-However if you do not use these providers, we've also provided generic
-instructions below:
+We have detailed instructions for integrating into these providers:
+
+
+
+
+If you do not use these providers, we've also provided generic instructions
+below:
## Installing Shorebird
diff --git a/src/content/docs/code-push/ci/github.mdx b/src/content/docs/code-push/ci/github.mdx
index be885d53..cb947ca9 100644
--- a/src/content/docs/code-push/ci/github.mdx
+++ b/src/content/docs/code-push/ci/github.mdx
@@ -9,6 +9,7 @@ sidebar:
{/* cspell:words shorebirdtech */}
import Authentication from './_authentication.mdx';
+import { LinkCard } from 'starlight-theme-nova/components';
The [Setup Shorebird](https://github.com/shorebirdtech/setup-shorebird) GitHub
Action allows you to integrate Shorebird into your existing GitHub Workflows.
@@ -209,5 +210,11 @@ tip The `shorebird-patch` action also outputs the patch number:
:::
-For an example of a fully automated development workflow, see our
-[Development Workflow Guide](/code-push/guides/development-workflow).
+For an example of a fully automated development workflow, see our Development
+Workflow Guide.
+
+
diff --git a/src/content/docs/code-push/guides/security-tools.mdx b/src/content/docs/code-push/guides/security-tools.mdx
index 97914daf..d145e55a 100644
--- a/src/content/docs/code-push/guides/security-tools.mdx
+++ b/src/content/docs/code-push/guides/security-tools.mdx
@@ -6,15 +6,23 @@ sidebar:
order: 40
---
+import { LinkCard } from 'starlight-theme-nova/components';
+
This article is about how Shorebird interacts with obfuscation and security
tooling.
For other Security-related topics:
-- _Company Security_ see our Handbook for
- [Security and Compliance](https://handbook.shorebird.dev/compliance/).
-- [_Patch Signing_](/code-push/guides/patch-signing) -- to cryptographically
- guarantee only you can change your app.
+
+
## Obfuscation
diff --git a/src/content/docs/code-push/guides/staging-patches.mdx b/src/content/docs/code-push/guides/staging-patches.mdx
index a433f92b..5ad95296 100644
--- a/src/content/docs/code-push/guides/staging-patches.mdx
+++ b/src/content/docs/code-push/guides/staging-patches.mdx
@@ -5,6 +5,7 @@ sidebar:
order: 17
---
+import { CodeTabs } from 'starlight-theme-nova/components';
import { Image } from 'astro:assets';
import goLive from '~/assets/staging_patches_change_track_dropdown.png';
import switchTrack from '~/assets/staging_patches_patch_context_menu.png';
@@ -53,17 +54,21 @@ Now that we've created our apps on shorebird, we need to create releases (one
for each platform). To create a release, we'll use the `shorebird release`
command.
-```sh
-# Create a release for Android
+
+```bash title="Android"
shorebird release android
+```
-# Create a release for iOS
+```bash title="iOS"
shorebird release ios
+```
-# Create a release for macOS
+```bash title="macOS"
shorebird release macos
```
+
+
We can verify the releases were created successfully by visiting
[Shorebird console](https://console.shorebird.dev).
@@ -105,17 +110,21 @@ class MainApp extends StatelessWidget {
Now that we've applied the changes, let's create a patch:
-```sh
-# Stage a patch on Android
+
+```bash title="Android"
shorebird patch android --track=staging
+```
-# Stage a patch on iOS
+```bash title="iOS"
shorebird patch ios --track=staging
+```
-# Stage a patch on macOS
+```bash title="macOS"
shorebird patch macos --track=staging
```
+
+
## Preview the release
Next, preview the app release locally on a device or emulator, use
diff --git a/src/content/docs/code-push/guides/testing-patches.mdx b/src/content/docs/code-push/guides/testing-patches.mdx
index 05e7ec69..c2773958 100644
--- a/src/content/docs/code-push/guides/testing-patches.mdx
+++ b/src/content/docs/code-push/guides/testing-patches.mdx
@@ -5,6 +5,8 @@ sidebar:
order: 18
---
+import { LinkCard } from 'starlight-theme-nova/components';
+
We recommend that you test your patches with a subset of users before
distributing to all users.
@@ -20,9 +22,14 @@ As part of our privacy stance, we _never_ know anything about your users, so we
have no way to tell users apart or to specify which users should receive a patch
from within our product. However, we do provide you mechanisms for controlling
updates via Shorebird with user information you have access to from within your
-company and your application. See the
-[Percentage Based Rollouts guide](/code-push/guides/percentage-based-rollouts)
-for examples.
+company and your application. See the Percentage Based Rollouts guide for
+examples.
+
+
We recommend using one of the following three approaches to distribute patches
to a subset of users (e.g. your QA team) for testing without affecting your
diff --git a/src/content/docs/code-push/initialize.mdx b/src/content/docs/code-push/initialize.mdx
index 216a0029..d6dbd850 100644
--- a/src/content/docs/code-push/initialize.mdx
+++ b/src/content/docs/code-push/initialize.mdx
@@ -6,6 +6,8 @@ sidebar:
order: 3
---
+import { LinkCard } from 'starlight-theme-nova/components';
+
:::note
If you are starting a new project, you can use
@@ -136,3 +138,16 @@ project, use `shorebird init --force`. This will overwrite your existing
by re-initializing shorebird.
:::
+
+## What's Next
+
+
+
diff --git a/src/content/docs/code-push/patch.mdx b/src/content/docs/code-push/patch.mdx
index 3d28f975..8aeed735 100644
--- a/src/content/docs/code-push/patch.mdx
+++ b/src/content/docs/code-push/patch.mdx
@@ -6,52 +6,33 @@ sidebar:
order: 6
---
-import { Tabs, TabItem } from '@astrojs/starlight/components';
+import { CodeTabs } from 'starlight-theme-nova/components';
Once you have published a release of your app, you can push updates using one of
the `shorebird patch` commands.
-
-
-
-```
+
+```bash title="Android"
shorebird patch android
```
-
-
-
-
-```
+```bash title="iOS"
shorebird patch ios
```
-
-
-
-
-```
+```bash title="Linux"
shorebird patch linux
```
-
-
-
-
-```
+```bash title="macOS"
shorebird patch macos
```
-
-
-
-
-```
+```bash title="Windows"
shorebird patch windows
```
-
-
+
This will do several things:
diff --git a/src/content/docs/code-push/preview.mdx b/src/content/docs/code-push/preview.mdx
index 5e686a0a..b733b5b0 100644
--- a/src/content/docs/code-push/preview.mdx
+++ b/src/content/docs/code-push/preview.mdx
@@ -6,6 +6,8 @@ sidebar:
order: 5
---
+import { LinkCard } from 'starlight-theme-nova/components';
+
Once you have [created a release](/code-push/release), you can preview your
release on an Android device, Android emulator, or iOS device using the
`shorebird preview` command.
@@ -37,3 +39,16 @@ artifacts that Shorebird creates. For example, if you launch your app normally
from Xcode or Android Studio _with a Release configuration_, you will see
Shorebird logs in its output. If you have published a patch, it should be
downloaded on the first run of your app and visible on subsequent runs.
+
+## What's Next
+
+
+
diff --git a/src/content/docs/code-push/release.mdx b/src/content/docs/code-push/release.mdx
index 650a52ed..74e126e8 100644
--- a/src/content/docs/code-push/release.mdx
+++ b/src/content/docs/code-push/release.mdx
@@ -7,6 +7,7 @@ sidebar:
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
+import { LinkCard } from 'starlight-theme-nova/components';
import { Image } from 'astro:assets';
import releaseDeleteDialog from '~/assets/release_delete_dialog.png';
@@ -454,3 +455,21 @@ shorebird release android --artifact=apk
That will produce _both_ .apk and .aab files. You can distribute either or both
as needed.
+
+## What's Next
+
+
+
+
diff --git a/src/content/docs/code-push/rollback.mdx b/src/content/docs/code-push/rollback.mdx
index 37ad9f1f..708d64e7 100644
--- a/src/content/docs/code-push/rollback.mdx
+++ b/src/content/docs/code-push/rollback.mdx
@@ -6,6 +6,7 @@ sidebar:
order: 7
---
+import { LinkCard } from 'starlight-theme-nova/components';
import { Image } from 'astro:assets';
import rollbackButton from '~/assets/rollback_button.png';
import rollbackPatch3Active from '~/assets/rollback_patch3_active.png';
@@ -117,5 +118,20 @@ available for review on [GitHub](https://github.com/shorebirdtech/). An overview
of our code locations is available under
[System Architecture](/code-push/system-architecture).
-See also
-[Shorebird Public Security Policies](https://handbook.shorebird.dev/security/).
+## Related
+
+
+
+
diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx
index c9947f84..fd6436c2 100644
--- a/src/content/docs/getting-started/index.mdx
+++ b/src/content/docs/getting-started/index.mdx
@@ -5,11 +5,15 @@ sidebar:
order: 1
---
-import { Tabs, TabItem } from '@astrojs/starlight/components';
+import {
+ CodeTabs,
+ LinkButton,
+ LinkCard,
+} from 'starlight-theme-nova/components';
Welcome to Shorebird! 👋
-In this guide, we’ll walk you through setting up Shorebird and integrating it
+In this guide, we'll walk you through setting up Shorebird and integrating it
into your app in just a few minutes.
## Sign up
@@ -17,9 +21,9 @@ into your app in just a few minutes.
The first thing you'll need to do is sign up for a Shorebird account. It's free
to do and you can signup in a manner of seconds.
-To create an account, head over to our
-[Web Console](https://console.shorebird.dev) and authenticate with one of the
-available authentication methods.
+
+ Create an Account
+
## Install
@@ -31,26 +35,17 @@ as you continue using our services.
To install the Shorebird command line interface (CLI):
-
-
-
-Open a terminal and run:
-
-```bash
+
+```bash title="Mac/Linux"
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
```
-
-
-Open a PowerShell terminal and run:
-
-```powershell
+```powershell title="Windows"
Set-ExecutionPolicy RemoteSigned -scope CurrentUser # Needed to execute remote scripts
iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1'|iex
```
-
-
+
:::note
@@ -186,6 +181,21 @@ more info.
## Next Steps
-Now that your account is set up and your app is initialized, you’re all set to
-begin. Check out the detailed sections here in our docs to learn more about each
-product and how to get the most out of them.
+Now that your account is set up and your app is initialized, you're all set to
+begin.
+
+
+
+
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
index e1a50df8..055f6b65 100644
--- a/src/content/docs/index.mdx
+++ b/src/content/docs/index.mdx
@@ -5,21 +5,30 @@ sidebar:
order: 1
---
+import { LinkButton, LinkCard } from 'starlight-theme-nova/components';
+
Welcome to Shorebird! 👋
Whether you're just getting started or looking to dive deeper into advance usage
of our products, you'll find everything you need here—from quick start guides to
in-depth technical references.
-Not sure how to get started? Check out
-[our Quick Start guide](/getting-started/) to get going.
+
+ Quick Start
+
## Contact Us
Still have questions? We are here to help and can be contacted in a variety of
ways.
-- We have an active Discord community where we're happy to help you. Join us at
- https://discord.gg/shorebird
-- If you have a private/confidential issue and would prefer email you can reach
- us at contact@shorebird.dev
+
+
diff --git a/src/styles/custom.css b/src/styles/custom.css
new file mode 100644
index 00000000..cafb7fdf
--- /dev/null
+++ b/src/styles/custom.css
@@ -0,0 +1,53 @@
+@import 'tailwindcss';
+@import 'starlight-theme-nova/tailwind.css';
+
+@font-face {
+ font-family: 'General Sans';
+ src: url('/fonts/GeneralSans-Variable.woff2') format('woff2');
+ font-weight: 200 700;
+ font-style: normal;
+ font-display: swap;
+}
+
+@font-face {
+ font-family: 'General Sans';
+ src: url('/fonts/GeneralSans-VariableItalic.woff2') format('woff2');
+ font-weight: 200 700;
+ font-style: italic;
+ font-display: swap;
+}
+
+:root {
+ --sl-color-bg: #0d1117;
+ --sl-color-bg-nav: color-mix(in srgb, var(--sl-color-bg) 50%, transparent);
+ --sl-color-black: var(--sl-color-bg);
+ --sl-color-gray-6: oklch(0.23 0.02 257.3);
+}
+
+:root[data-theme='light'] {
+ --sl-color-bg: white;
+ --sl-color-bg-nav: color-mix(in srgb, white 80%, transparent);
+ --sl-color-black: white;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+ font-family: 'General Sans', sans-serif;
+}
+
+/* Add spacing between paragraphs and interactive components (e.g. LinkButton) */
+.sl-markdown-content > p + .not-content {
+ margin-top: 1rem;
+}
+
+/* Make code blocks stand out from surrounding content (dark mode only) */
+:root:not([data-theme='light']) {
+ .astro-code,
+ .code-tabs {
+ background-color: var(--sl-color-gray-6) !important;
+ }
+}
diff --git a/src/tailwind.css b/src/tailwind.css
deleted file mode 100644
index 3fba7f0d..00000000
--- a/src/tailwind.css
+++ /dev/null
@@ -1,34 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-/* Dark mode colors. */
-:root {
- --sl-color-accent-low: #002a2d;
- --sl-color-accent: #007880;
- --sl-color-accent-high: #8bd8de;
- --sl-color-white: #ffffff;
- --sl-color-gray-1: #edeeed;
- --sl-color-gray-2: #c1c2c2;
- --sl-color-gray-3: #8a8c8b;
- --sl-color-gray-4: #575858;
- --sl-color-gray-5: #373838;
- --sl-color-gray-6: #262727;
- --sl-color-black: #181818;
-}
-
-/* Light mode colors. */
-:root[data-theme='light'] {
- --sl-color-accent-low: #abe3e7;
- --sl-color-accent: #007b83;
- --sl-color-accent-high: #003a3e;
- --sl-color-white: #181818;
- --sl-color-gray-1: #262727;
- --sl-color-gray-2: #373838;
- --sl-color-gray-3: #575858;
- --sl-color-gray-4: #8a8c8b;
- --sl-color-gray-5: #c1c2c2;
- --sl-color-gray-6: #edeeed;
- --sl-color-gray-7: #f6f6f6;
- --sl-color-black: #ffffff;
-}
diff --git a/tailwind.config.mjs b/tailwind.config.mjs
deleted file mode 100644
index 17562ef6..00000000
--- a/tailwind.config.mjs
+++ /dev/null
@@ -1,32 +0,0 @@
-// cspell:words astrojs tailwindcss astro
-
-import starlightPlugin from '@astrojs/starlight-tailwind';
-
-// Generated color palettes
-const accent = {
- 200: '#8bd8de',
- 600: '#007b83',
- 900: '#003a3e',
- 950: '#002a2d',
-};
-const gray = {
- 100: '#f6f6f6',
- 200: '#edeeed',
- 300: '#c1c2c2',
- 400: '#8a8c8b',
- 500: '#575858',
- 700: '#373838',
- 800: '#262727',
- 900: '#181818',
-};
-
-/** @type {import('tailwindcss').Config} */
-export default {
- content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
- plugins: [starlightPlugin()],
- theme: {
- extend: {
- colors: { accent, gray },
- },
- },
-};