@astrojs/starlight 0.12.1 → 0.13.0

package/translations/vi.json

@@ -18,5 +18,9 @@
   "page.lastUpdated": "Cập nhật lần cuối:",
   "page.previousLink": "Tiếp",
   "page.nextLink": "Trước",
-  "404.text": "Không tìm thấy trang. Kiểm tra URL hoặc thử sử dụng thanh tìm kiếm."
+  "404.text": "Không tìm thấy trang. Kiểm tra URL hoặc thử sử dụng thanh tìm kiếm.",
+  "aside.note": "Note",
+  "aside.tip": "Tip",
+  "aside.caution": "Caution",
+  "aside.danger": "Danger"
 }

package/translations/zh-CN.json

@@ -18,5 +18,9 @@
   "page.lastUpdated": "最近更新：",
   "page.previousLink": "上一页",
   "page.nextLink": "下一页",
-  "404.text": "页面未找到。检查 URL 或尝试使用搜索栏。"
+  "404.text": "页面未找到。检查 URL 或尝试使用搜索栏。",
+  "aside.note": "注意",
+  "aside.tip": "提示",
+  "aside.caution": "警告",
+  "aside.danger": "危险"
 }

package/utils/base.ts

@@ -1,15 +1,15 @@
-import { stripLeadingAndTrailingSlashes, stripTrailingSlash } from './path';
+import { stripLeadingSlash, stripTrailingSlash } from './path';
 
 const base = stripTrailingSlash(import.meta.env.BASE_URL);
 
 /** Get the a root-relative URL path with the site’s `base` prefixed. */
 export function pathWithBase(path: string) {
-	path = stripLeadingAndTrailingSlashes(path);
-	return path ? base + '/' + path + '/' : base + '/';
+	path = stripLeadingSlash(path);
+	return path ? base + '/' + path : base + '/';
 }
 
 /** Get the a root-relative file URL path with the site’s `base` prefixed. */
 export function fileWithBase(path: string) {
-	path = stripLeadingAndTrailingSlashes(path);
+	path = stripLeadingSlash(path);
 	return path ? base + '/' + path : base;
 }

package/utils/createPathFormatter.ts

@@ -0,0 +1,57 @@
+import type { AstroConfig } from 'astro';
+import { fileWithBase, pathWithBase } from './base';
+import {
+	ensureHtmlExtension,
+	ensureTrailingSlash,
+	stripHtmlExtension,
+	stripTrailingSlash,
+} from './path';
+
+interface FormatPathOptions {
+	format?: AstroConfig['build']['format'];
+	trailingSlash?: AstroConfig['trailingSlash'];
+}
+
+const formatStrategies = {
+	file: {
+		addBase: fileWithBase,
+		handleExtension: (href: string) => ensureHtmlExtension(href),
+	},
+	directory: {
+		addBase: pathWithBase,
+		handleExtension: (href: string) => stripHtmlExtension(href),
+	},
+};
+
+const trailingSlashStrategies = {
+	always: ensureTrailingSlash,
+	never: stripTrailingSlash,
+	ignore: (href: string) => href,
+};
+
+/** Format a path based on the project config. */
+function formatPath(
+	href: string,
+	{ format = 'directory', trailingSlash = 'ignore' }: FormatPathOptions
+) {
+	const formatStrategy = formatStrategies[format];
+	const trailingSlashStrategy = trailingSlashStrategies[trailingSlash];
+
+	// Add base
+	href = formatStrategy.addBase(href);
+
+	// Handle extension
+	href = formatStrategy.handleExtension(href);
+
+	// Skip trailing slash handling for `build.format: 'file'`
+	if (format === 'file') return href;
+
+	// Handle trailing slash
+	href = href === '/' ? href : trailingSlashStrategy(href);
+
+	return href;
+}
+
+export function createPathFormatter(opts: FormatPathOptions) {
+	return (href: string) => formatPath(href, opts);
+}

package/utils/format-path.ts

@@ -0,0 +1,7 @@
+import project from 'virtual:starlight/project-context';
+import { createPathFormatter } from './createPathFormatter';
+
+export const formatPath = createPathFormatter({
+	format: project.build.format,
+	trailingSlash: project.trailingSlash,
+});

package/utils/navigation.ts

@@ -1,18 +1,19 @@
 import { basename, dirname } from 'node:path';
 import config from 'virtual:starlight/user-config';
-import type { PrevNextLinkConfig } from '../schemas/prevNextLink';
-import { pathWithBase } from './base';
-import { pickLang } from './i18n';
-import { getLocaleRoutes, type Route } from './routing';
-import { localeToLang, slugToPathname } from './slugs';
-import { ensureLeadingAndTrailingSlashes, ensureTrailingSlash } from './path';
 import type { Badge } from '../schemas/badge';
+import type { PrevNextLinkConfig } from '../schemas/prevNextLink';
 import type {
 	AutoSidebarGroup,
 	LinkHTMLAttributes,
 	SidebarItem,
 	SidebarLinkItem,
 } from '../schemas/sidebar';
+import { createPathFormatter } from './createPathFormatter';
+import { formatPath } from './format-path';
+import { pickLang } from './i18n';
+import { ensureLeadingSlash } from './path';
+import { getLocaleRoutes, type Route } from './routing';
+import { localeToLang, slugToPathname } from './slugs';
 
 const DirKey = Symbol('DirKey');
 
@@ -118,7 +119,7 @@ function linkFromConfig(
 ) {
 	let href = item.link;
 	if (!isAbsolute(href)) {
-		href = ensureLeadingAndTrailingSlashes(href);
+		href = ensureLeadingSlash(href);
 		// Inject current locale into link.
 		if (locale) href = '/' + locale + href;
 	}
@@ -134,11 +135,21 @@ function makeLink(
 	badge?: Badge,
 	attrs?: LinkHTMLAttributes
 ): Link {
-	if (!isAbsolute(href)) href = pathWithBase(href);
-	const isCurrent = encodeURI(href) === ensureTrailingSlash(currentPathname);
+	if (!isAbsolute(href)) {
+		href = formatPath(href);
+	}
+
+	const isCurrent = pathsMatch(encodeURI(href), currentPathname);
+
 	return { type: 'link', label, href, isCurrent, badge, attrs: attrs ?? {} };
 }
 
+/** Test if two paths are equivalent even if formatted differently. */
+function pathsMatch(pathA: string, pathB: string) {
+	const format = createPathFormatter({ trailingSlash: 'never' });
+	return format(pathA) === format(pathB);
+}
+
 /** Get the segments leading to a page. */
 function getBreadcrumbs(path: string, baseDir: string): string[] {
 	// Strip extension from path.
@@ -333,7 +344,7 @@ function applyPrevNextLinkConfig(
 		} else if (config.link && config.label) {
 			// If there is no link and the frontmatter contains both a URL and a label,
 			// create a new link.
-			return makeLink(config.link, config.label, config.link);
+			return makeLink(config.link, config.label, '');
 		}
 	}
 	// Otherwise, if the global config is enabled, return the generated link if any.

package/utils/path.ts

@@ -35,3 +35,18 @@ export function stripLeadingAndTrailingSlashes(href: string): string {
 	href = stripTrailingSlash(href);
 	return href;
 }
+
+/** Remove the extension from a path. */
+export function stripHtmlExtension(path: string) {
+	const pathWithoutTrailingSlash = stripTrailingSlash(path);
+	return pathWithoutTrailingSlash.endsWith('.html') ? pathWithoutTrailingSlash.slice(0, -5) : path;
+}
+
+/** Add '.html' extension to a path. */
+export function ensureHtmlExtension(path: string) {
+	path = stripLeadingAndTrailingSlashes(path);
+	if (!path.endsWith('.html')) {
+		path = path ? path + '.html' : '/index.html';
+	}
+	return ensureLeadingSlash(path);
+}

package/utils/user-config.ts

@@ -1,6 +1,7 @@
 import { z } from 'astro/zod';
 import { parse as bcpParse, stringify as bcpStringify } from 'bcp-47';
 import { ComponentConfigSchema } from '../schemas/components';
+import { ExpressiveCodeSchema } from '../schemas/expressiveCode';
 import { FaviconSchema } from '../schemas/favicon';
 import { HeadConfigSchema } from '../schemas/head';
 import { LogoConfigSchema } from '../schemas/logo';
@@ -183,6 +184,12 @@ const UserConfigSchema = z.object({
 	/** The default favicon for your site which should be a path to an image in the `public/` directory. */
 	favicon: FaviconSchema(),
 
+	/**
+	 * Define how code blocks are rendered by passing options to Expressive Code,
+	 * or disable the integration by passing `false`.
+	 */
+	expressiveCode: ExpressiveCodeSchema(),
+
 	/** Specify paths to components that should override Starlight’s default components */
 	components: ComponentConfigSchema(),
 

package/virtual.d.ts

@@ -3,7 +3,15 @@ declare module 'virtual:starlight/user-config' {
 	export default Config;
 }
 declare module 'virtual:starlight/project-context' {
-	export default { root: string, srcDir: string };
+	const ProjectContext: {
+		root: string;
+		srcDir: string;
+		trailingSlash: import('astro').AstroConfig['trailingSlash'];
+		build: {
+			format: import('astro').AstroConfig['build']['format'];
+		};
+	};
+	export default ProjectContext;
 }
 
 declare module 'virtual:starlight/user-css' {}