Add kudos option to add “Built with Starlight” badge to site footers (#…

…1958) Co-authored-by: Luiz Ferraz <[email protected]> Co-authored-by: NotJaime13 <[email protected]> Co-authored-by: HiDeoo <[email protected]> Co-authored-by: Florian Lefebvre <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: liruifengv <[email protected]> Co-authored-by: Adam Matthiesen <[email protected]> Co-authored-by: Atharva <[email protected]> Co-authored-by: trueberryless <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Jacob Jenkins <[email protected]> Co-authored-by: Bryce Russell <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
withastro · Jun 5, 2024 · 081d1a9 · 081d1a9
1 parent ee0cd38
commit 081d1a9
Show file tree

Hide file tree

Showing 33 changed files with 113 additions and 29 deletions.
diff --git a/.changeset/sharp-crabs-sparkle.md b/.changeset/sharp-crabs-sparkle.md
@@ -0,0 +1,5 @@
+---
+'@astrojs/starlight': minor
+---
+
+Allows users to opt into displaying a “Built with Starlight” link in the site footer
diff --git a/docs/src/content/docs/reference/configuration.mdx b/docs/src/content/docs/reference/configuration.mdx
@@ -569,3 +569,13 @@ starlight({
 ```
 
 See the [Plugins Reference](/reference/plugins/) for details about creating your own plugins.
+
+### `credits`
+
+Enable displaying a “Built with Starlight” link in your site’s footer.
+
+```js
+starlight({
+	credits: true,
+});
+```
diff --git a/packages/starlight/__tests__/basics/config-errors.test.ts b/packages/starlight/__tests__/basics/config-errors.test.ts
@@ -44,6 +44,7 @@ test('parses valid config successfully', () => {
 		    "ThemeSelect": "@astrojs/starlight/components/ThemeSelect.astro",
 		    "TwoColumnContent": "@astrojs/starlight/components/TwoColumnContent.astro",
 		  },
+		  "credits": false,
 		  "customCss": [],
 		  "defaultLocale": {
 		    "dir": "ltr",

diff --git a/packages/starlight/components/Footer.astro b/packages/starlight/components/Footer.astro
@@ -4,26 +4,55 @@ import type { Props } from '../props';
 import EditLink from 'virtual:starlight/components/EditLink';
 import LastUpdated from 'virtual:starlight/components/LastUpdated';
 import Pagination from 'virtual:starlight/components/Pagination';
+import config from 'virtual:starlight/user-config';
+import { Icon } from '../components';
 ---
 
-<footer>
+<footer class="sl-flex">
 	<div class="meta sl-flex">
 		<EditLink {...Astro.props} />
 		<LastUpdated {...Astro.props} />
 	</div>
 	<Pagination {...Astro.props} />
+
+	{
+		config.credits && (
+			<a class="kudos sl-flex" href="https://starlight.astro.build">
+				<Icon name={'starlight'} /> {Astro.props.labels['builtWithStarlight.label']}
+			</a>
+		)
+	}
 </footer>
 
 <style>
+	footer {
+		flex-direction: column;
+		gap: 1.5rem;
+	}
 	.meta {
 		gap: 0.75rem 3rem;
 		justify-content: space-between;
 		flex-wrap: wrap;
-		margin-block: 3rem 1.5rem;
+		margin-top: 3rem;
 		font-size: var(--sl-text-sm);
 		color: var(--sl-color-gray-3);
 	}
 	.meta > :global(p:only-child) {
 		margin-inline-start: auto;
 	}
+
+	.kudos {
+		align-items: center;
+		gap: 0.5em;
+		margin: 1.5rem auto;
+		font-size: var(--sl-text-xs);
+		text-decoration: none;
+		color: var(--sl-color-gray-3);
+	}
+	.kudos :global(svg) {
+		color: var(--sl-color-orange);
+	}
+	.kudos:hover {
+		color: var(--sl-color-white);
+	}
 </style>
diff --git a/packages/starlight/schemas/i18n.ts b/packages/starlight/schemas/i18n.ts
@@ -138,6 +138,12 @@ function starlightI18nSchema() {
 			'fileTree.directory': z
 				.string()
 				.describe('Label for the directory icon in the file tree component.'),
+
+			'builtWithStarlight.label': z
+				.string()
+				.describe(
+					'Label for the “Built with Starlight” badge optionally displayed in the site footer.'
+				),
 		})
 		.partial();
 }

diff --git a/packages/starlight/translations/ar.json b/packages/starlight/translations/ar.json
@@ -24,5 +24,6 @@
   "aside.tip": "نصيحة",
   "aside.caution": "تنبيه",
   "aside.danger": "تحذير",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/cs.json b/packages/starlight/translations/cs.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/da.json b/packages/starlight/translations/da.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/de.json b/packages/starlight/translations/de.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tipp",
   "aside.caution": "Achtung",
   "aside.danger": "Gefahr",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Erstellt mit Starlight"
 }
diff --git a/packages/starlight/translations/en.json b/packages/starlight/translations/en.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/es.json b/packages/starlight/translations/es.json
@@ -27,5 +27,6 @@
   "expressiveCode.copyButtonCopied": "¡Copiado!",
   "expressiveCode.copyButtonTooltip": "Copiar al portapapeles",
   "expressiveCode.terminalWindowFallbackTitle": "Ventana de terminal",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Hecho con Starlight"
 }
diff --git a/packages/starlight/translations/fa.json b/packages/starlight/translations/fa.json
@@ -24,5 +24,6 @@
   "aside.tip": "نکته",
   "aside.caution": "احتیاط",
   "aside.danger": "خطر",
-  "fileTree.directory": "فهرست"
+  "fileTree.directory": "فهرست",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/fr.json b/packages/starlight/translations/fr.json
@@ -27,5 +27,6 @@
   "expressiveCode.copyButtonCopied": "Copié !",
   "expressiveCode.copyButtonTooltip": "Copier dans le presse-papiers",
   "expressiveCode.terminalWindowFallbackTitle": "Fenêtre de terminal",
-  "fileTree.directory": "Répertoire"
+  "fileTree.directory": "Répertoire",
+  "builtWithStarlight.label": "Créé avec Starlight"
 }
diff --git a/packages/starlight/translations/gl.json b/packages/starlight/translations/gl.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/he.json b/packages/starlight/translations/he.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/hi.json b/packages/starlight/translations/hi.json
@@ -24,5 +24,6 @@
   "aside.tip": "संकेत",
   "aside.caution": "सावधानी",
   "aside.danger": "खतरा",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Starlight द्वारा निर्मित"
 }
diff --git a/packages/starlight/translations/id.json b/packages/starlight/translations/id.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tips",
   "aside.caution": "Perhatian",
   "aside.danger": "Bahaya",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/it.json b/packages/starlight/translations/it.json
@@ -24,5 +24,6 @@
   "aside.tip": "Consiglio",
   "aside.caution": "Attenzione",
   "aside.danger": "Pericolo",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/ja.json b/packages/starlight/translations/ja.json
@@ -24,5 +24,6 @@
   "aside.tip": "ヒント",
   "aside.caution": "注意",
   "aside.danger": "危険",
-  "fileTree.directory": "ディレクトリ"
+  "fileTree.directory": "ディレクトリ",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/ko.json b/packages/starlight/translations/ko.json
@@ -24,5 +24,6 @@
   "aside.tip": "팁",
   "aside.caution": "주의",
   "aside.danger": "위험",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/nb.json b/packages/starlight/translations/nb.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Laget med Starlight"
 }
diff --git a/packages/starlight/translations/nl.json b/packages/starlight/translations/nl.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Opgepast",
   "aside.danger": "Gevaar",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/pl.json b/packages/starlight/translations/pl.json
@@ -27,5 +27,6 @@
   "fileTree.directory": "Folder",
   "expressiveCode.copyButtonCopied": "Skopiowane!",
   "expressiveCode.copyButtonTooltip": "Skopiuj do schowka",
-  "expressiveCode.terminalWindowFallbackTitle": "Okno terminala"
+  "expressiveCode.terminalWindowFallbackTitle": "Okno terminala",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/pt.json b/packages/starlight/translations/pt.json
@@ -24,5 +24,6 @@
   "aside.tip": "Dica",
   "aside.caution": "Cuidado",
   "aside.danger": "Perigo",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Feito com Starlight"
 }
diff --git a/packages/starlight/translations/ro.json b/packages/starlight/translations/ro.json
@@ -24,5 +24,6 @@
   "aside.tip": "Sfat",
   "aside.caution": "Atenție",
   "aside.danger": "Pericol",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/ru.json b/packages/starlight/translations/ru.json
@@ -27,5 +27,6 @@
   "fileTree.directory": "Директория",
   "expressiveCode.copyButtonCopied": "Скопировано!",
   "expressiveCode.copyButtonTooltip": "Копировать",
-  "expressiveCode.terminalWindowFallbackTitle": "Окно терминала"
+  "expressiveCode.terminalWindowFallbackTitle": "Окно терминала",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/sv.json b/packages/starlight/translations/sv.json
@@ -24,5 +24,6 @@
   "aside.tip": "Tip",
   "aside.caution": "Caution",
   "aside.danger": "Danger",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/tr.json b/packages/starlight/translations/tr.json
@@ -24,5 +24,6 @@
   "aside.tip": "İpucu",
   "aside.caution": "Dikkat",
   "aside.danger": "Tehlike",
-  "fileTree.directory": "Dizin"
+  "fileTree.directory": "Dizin",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/uk.json b/packages/starlight/translations/uk.json
@@ -24,5 +24,6 @@
   "aside.tip": "Порада",
   "aside.caution": "Обережно",
   "aside.danger": "Небезпечно",
-  "fileTree.directory": "Directory"
+  "fileTree.directory": "Directory",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/vi.json b/packages/starlight/translations/vi.json
@@ -24,5 +24,6 @@
   "aside.tip": "Mẹo",
   "aside.caution": "Thận trọng",
   "aside.danger": "Nguy hiểm",
-  "fileTree.directory": "Danh mục"
+  "fileTree.directory": "Danh mục",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/translations/zh-CN.json b/packages/starlight/translations/zh-CN.json
@@ -24,5 +24,6 @@
   "aside.tip": "提示",
   "aside.caution": "警告",
   "aside.danger": "危险",
-  "fileTree.directory": "文件夹"
+  "fileTree.directory": "文件夹",
+  "builtWithStarlight.label": "基于 Starlight 构建"
 }
diff --git a/packages/starlight/translations/zh-TW.json b/packages/starlight/translations/zh-TW.json
@@ -24,5 +24,6 @@
   "aside.tip": "提示",
   "aside.caution": "警告",
   "aside.danger": "危險",
-  "fileTree.directory": "目錄"
+  "fileTree.directory": "目錄",
+  "builtWithStarlight.label": "Built with Starlight"
 }
diff --git a/packages/starlight/utils/user-config.ts b/packages/starlight/utils/user-config.ts
@@ -208,6 +208,12 @@ const UserConfigSchema = z.object({
 
 	/** Disable Starlight's default 404 page. */
 	disable404Route: z.boolean().default(false).describe("Disable Starlight's default 404 page."),
+
+	/** Enable displaying a “Built with Starlight” link in your site’s footer. */
+	credits: z
+		.boolean()
+		.default(false)
+		.describe('Enable displaying a “Built with Starlight” link in your site’s footer.'),
 });
 
 export const StarlightConfigSchema = UserConfigSchema.strict().transform(