@astrojs/starlight 0.17.4 → 0.18.1

package/404.astro

@@ -7,6 +7,8 @@ import { generateRouteData } from './utils/route-data';
 import type { StarlightDocsEntry } from './utils/routing';
 import { useTranslations } from './utils/translations';
 
+export const prerender = true;
+
 const { lang = 'en', dir = 'ltr' } = config.defaultLocale || {};
 let locale = config.defaultLocale?.locale;
 if (locale === 'root') locale = undefined;

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @astrojs/starlight
 
+## 0.18.1
+
+### Patch Changes
+
+- [#1487](https://github.com/withastro/starlight/pull/1487) [`6a72bda`](https://github.com/withastro/starlight/commit/6a72bda8c5569e2eda68fdf258ae9b1dc8b320d6) Thanks [@NavyStack](https://github.com/NavyStack)! - Improves Korean UI translations
+
+- [#1489](https://github.com/withastro/starlight/pull/1489) [`b0d36de`](https://github.com/withastro/starlight/commit/b0d36de3398d4895603a787b612b1f0747defbdc) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential text rendering issue with text containing colons.
+
+## 0.18.0
+
+### Minor Changes
+
+- [#1454](https://github.com/withastro/starlight/pull/1454) [`1d9ef56`](https://github.com/withastro/starlight/commit/1d9ef567907bed7210e75ab3460f536c0768a87f) Thanks [@Fryuni](https://github.com/Fryuni)! - Makes Starlight compatible with [on-demand server rendering](https://docs.astro.build/en/guides/server-side-rendering/) (sometimes referred to as server-side rendering or SSR).
+
+  Starlight pages are always prerendered, even when using `output: 'server'`.
+
+- [#1454](https://github.com/withastro/starlight/pull/1454) [`1d9ef56`](https://github.com/withastro/starlight/commit/1d9ef567907bed7210e75ab3460f536c0768a87f) Thanks [@Fryuni](https://github.com/Fryuni)! - Enables Astro’s [`experimental.globalRoutePriority`](https://docs.astro.build/en/reference/configuration-reference/#experimentalglobalroutepriority) option and bumps the minimum required Astro version.
+
+  ⚠️ **BREAKING CHANGE** The minimum supported Astro version is now 4.2.7. Upgrade Astro and Starlight together:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
 ## 0.17.4
 
 ### Patch Changes

package/index.astro

@@ -5,6 +5,8 @@ import { paths } from './utils/routing';
 
 import Page from './components/Page.astro';
 
+export const prerender = true;
+
 export async function getStaticPaths() {
 	return paths;
 }

package/index.ts

@@ -43,11 +43,15 @@ export default function StarlightIntegration({
 					injectRoute({
 						pattern: '404',
 						entrypoint: '@astrojs/starlight/404.astro',
+						// Ensure page is pre-rendered even when project is on server output mode
+						prerender: true,
 					});
 				}
 				injectRoute({
 					pattern: '[...slug]',
 					entrypoint: '@astrojs/starlight/index.astro',
+					// Ensure page is pre-rendered even when project is on server output mode
+					prerender: true,
 				});
 				// Add built-in integrations only if they are not already added by the user through the
 				// config or by a plugin.
@@ -78,6 +82,9 @@ export default function StarlightIntegration({
 					scopedStyleStrategy: 'where',
 					// If not already configured, default to prefetching all links on hover.
 					prefetch: config.prefetch ?? { prefetchAll: true },
+					experimental: {
+						globalRoutePriority: true,
+					},
 				});
 			},
 

package/integrations/asides.ts

@@ -2,7 +2,14 @@
 
 import type { AstroConfig, AstroUserConfig } from 'astro';
 import { h as _h, s as _s, type Properties } from 'hastscript';
-import type { Paragraph as P, Root } from 'mdast';
+import type { Node, Paragraph as P, Parent, Root } from 'mdast';
+import {
+	type Directives,
+	directiveToMarkdown,
+	type TextDirective,
+	type LeafDirective,
+} from 'mdast-util-directive';
+import { toMarkdown } from 'mdast-util-to-markdown';
 import remarkDirective from 'remark-directive';
 import type { Plugin, Transformer } from 'unified';
 import { remove } from 'unist-util-remove';
@@ -37,6 +44,40 @@ function s(el: string, attrs: Properties = {}, children: any[] = []): P {
 	};
 }
 
+/** Checks if a node is a directive. */
+function isNodeDirective(node: Node): node is Directives {
+	return (
+		node.type === 'textDirective' ||
+		node.type === 'leafDirective' ||
+		node.type === 'containerDirective'
+	);
+}
+
+/**
+ * Transforms back directives not handled by Starlight to avoid breaking user content.
+ * For example, a user might write `x:y` in the middle of a sentence, where `:y` would be
+ * identified as a text directive, which are not used by Starlight, and we definitely want that
+ * text to be rendered verbatim in the output.
+ */
+function transformUnhandledDirective(
+	node: TextDirective | LeafDirective,
+	index: number,
+	parent: Parent
+) {
+	const textNode = {
+		type: 'text',
+		value: toMarkdown(node, { extensions: [directiveToMarkdown()] }),
+	} as const;
+	if (node.type === 'textDirective') {
+		parent.children[index] = textNode;
+	} else {
+		parent.children[index] = {
+			type: 'paragraph',
+			children: [textNode],
+		};
+	}
+}
+
 /**
  * remark plugin that converts blocks delimited with `:::` into styled
  * asides (a.k.a. “callouts”, “admonitions”, etc.). Depends on the
@@ -102,7 +143,11 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
 		const locale = pathToLocale(file.history[0], options);
 		const t = options.useTranslations(locale);
 		visit(tree, (node, index, parent) => {
-			if (!parent || index === undefined || node.type !== 'containerDirective') {
+			if (!parent || index === undefined || !isNodeDirective(node)) {
+				return;
+			}
+			if (node.type === 'textDirective' || node.type === 'leafDirective') {
+				transformUnhandledDirective(node, index, parent);
 				return;
 			}
 			const variant = node.name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.17.4",
+  "version": "0.18.1",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -163,7 +163,7 @@
     "./style/markdown.css": "./style/markdown.css"
   },
   "peerDependencies": {
-    "astro": "^4.0.0"
+    "astro": "^4.2.7"
   },
   "devDependencies": {
     "@astrojs/markdown-remark": "^4.2.1",
@@ -183,6 +183,7 @@
     "hast-util-select": "^6.0.2",
     "hastscript": "^8.0.0",
     "mdast-util-directive": "^3.0.0",
+    "mdast-util-to-markdown": "^2.1.0",
     "pagefind": "^1.0.3",
     "rehype": "^13.0.1",
     "remark-directive": "^3.0.0",

package/translations/ko.json

@@ -1,24 +1,24 @@
 {
-  "skipLink.label": "컨텐츠로 이동",
+  "skipLink.label": "컨텐츠로 건너뛰기",
   "search.label": "검색",
-  "search.shortcutLabel": "(검색을 위해 / 키를 누르세요)",
+  "search.shortcutLabel": "(검색하려면 / 를 누르세요)",
   "search.cancelLabel": "취소",
-  "search.devWarning": "검색 기능은 프로덕션 환경에서만 사용할 수 있습니다.\n사이트를 로컬 환경에서 테스트하기 위해 빌드하고 미리보기(Preview) 하세요.",
+  "search.devWarning": "검색 기능은 운영 환경에서만 사용할 수 있습니다. \n로컬에서 테스트하려면 사이트를 빌드하고 미리보기를 해보세요.",
   "themeSelect.accessibleLabel": "테마 선택",
-  "themeSelect.dark": "어두움",
-  "themeSelect.light": "밝음",
+  "themeSelect.dark": "다크",
+  "themeSelect.light": "라이트",
   "themeSelect.auto": "자동",
   "languageSelect.accessibleLabel": "언어 선택",
   "menuButton.accessibleLabel": "메뉴",
   "sidebarNav.accessibleLabel": "메인",
-  "tableOfContents.onThisPage": "목차",
+  "tableOfContents.onThisPage": "이 페이지에서는",
   "tableOfContents.overview": "개요",
-  "i18n.untranslatedContent": "이 컨텐츠는 아직 번역되지 않았습니다.",
+  "i18n.untranslatedContent": "이 내용은 아직 번역본이 없습니다.",
   "page.editLink": "페이지 수정",
-  "page.lastUpdated": "최종 수정:",
-  "page.previousLink": "이전 페이지",
-  "page.nextLink": "다음 페이지",
-  "404.text": "페이지를 찾을 수 없습니다. URL을 확인하거나 검색창을 사용해보세요.",
+  "page.lastUpdated": "마지막 업데이트:",
+  "page.previousLink": "이전",
+  "page.nextLink": "다음",
+  "404.text": "페이지를 찾을 수 없습니다. URL을 확인하거나 검색 막대를 사용해 보세요.",
   "aside.note": "노트",
   "aside.tip": "팁",
   "aside.caution": "주의",