@astrojs/starlight 0.7.1 → 0.7.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @astrojs/starlight
 
+## 0.7.3
+
+### Patch Changes
+
+- [#525](https://github.com/withastro/starlight/pull/525) [`87caf21`](https://github.com/withastro/starlight/commit/87caf21adaac98cf8342dac4db97ace327849616) Thanks [@delucis](https://github.com/delucis)! - Improve inline code and code block support in RTL languages
+
+- [#537](https://github.com/withastro/starlight/pull/537) [`56c19bc`](https://github.com/withastro/starlight/commit/56c19bc871f2a4f205d4b0bb833fd81a3ed2e0f0) Thanks [@carlgleisner](https://github.com/carlgleisner)! - Add Swedish UI translations.
+
+- [#528](https://github.com/withastro/starlight/pull/528) [`f5e5503`](https://github.com/withastro/starlight/commit/f5e55036987db98dbd0be7a84eb7819a48234a2f) Thanks [@jsparkdev](https://github.com/jsparkdev)! - add Korean language support
+
+## 0.7.2
+
+### Patch Changes
+
+- [#506](https://github.com/withastro/starlight/pull/506) [`5e3133c`](https://github.com/withastro/starlight/commit/5e3133c42232b201b981cf4b3bc1c3dd56b09fa5) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Improve table of content current item highlight behavior
+
+- [#499](https://github.com/withastro/starlight/pull/499) [`fcff49e`](https://github.com/withastro/starlight/commit/fcff49ee4260ad68e80833712e161cbb978a2562) Thanks [@D3vil0p3r](https://github.com/D3vil0p3r)! - Add icons for Instagram
+
+- [#502](https://github.com/withastro/starlight/pull/502) [`3c87a16`](https://github.com/withastro/starlight/commit/3c87a16de3c867ad89294a0ea84d63eca2e74d7a) Thanks [@Mrahmani71](https://github.com/Mrahmani71)! - Add Farsi UI translations
+
+- [#496](https://github.com/withastro/starlight/pull/496) [`cd28392`](https://github.com/withastro/starlight/commit/cd28392ac73ac0ba1a441328fcd1d65d7d441366) Thanks [@lorenzolewis](https://github.com/lorenzolewis)! - Fix `lastUpdated` date position to be consistent
+
+- [#402](https://github.com/withastro/starlight/pull/402) [`d8669b8`](https://github.com/withastro/starlight/commit/d8669b869761ac15d1d611eda7dd94a62ce0fd7a) Thanks [@chopfitzroy](https://github.com/chopfitzroy)! - Fix content sometimes appearing above the mobile table of contents.
+
 ## 0.7.1
 
 ### Patch Changes

package/components/Footer.astro

@@ -48,4 +48,7 @@ const prevNextLinks = getPrevNextLinks(sidebar, config.pagination, {
 		font-size: var(--sl-text-sm);
 		color: var(--sl-color-gray-3);
 	}
+	.meta > :global(p:only-child) {
+		margin-inline-start: auto;
+	}
 </style>

package/components/Icons.ts

@@ -82,4 +82,6 @@ export const Icons = {
 		'<path d="M2.5 1 1 4.8v15.4h5.5V23h3.1l3-2.8H17l6-5.7V1H2.6ZM21 13.5l-3.4 3.3H12l-3 2.8v-2.8H4.5V3H21v10.5Zm-3.4-6.8v5.8h-2V6.7h2Zm-5.5 0v5.8h-2V6.7h2Z"/>',
 	microsoftTeams:
 		'<path d="M13.78 7.2a3.63 3.63 0 1 0-4.3-3.68h1.78a2.52 2.52 0 0 1 2.52 2.53V7.2zM7.34 18.8h3.92a2.52 2.52 0 0 0 2.52-2.52V8.37h4.17c.58.01 1.04.5 1.03 1.07v6.45a6.3 6.3 0 0 1-6.14 6.43 6.3 6.3 0 0 1-5.5-3.52zm16.1-14.06a2.51 2.51 0 1 1-5.02 0 2.51 2.51 0 0 1 5.02 0zm-3.36 14.24h-.17c.4-1 .59-2.05.57-3.11V9.46c0-.38-.07-.75-.23-1.09h2.69c.58 0 1.06.48 1.06 1.06v5.65a3.9 3.9 0 0 1-3.9 3.9h-.02z"/><path d="M1.02 5.02h10.24c.56 0 1.02.46 1.02 1.03v10.23a1.02 1.02 0 0 1-1.02 1.02H1.02A1.02 1.02 0 0 1 0 16.28V6.04c0-.56.46-1.02 1.02-1.02zm7.81 3.9V7.84H3.45v1.08h2.03v5.57h1.3V8.92h2.05z"/>',
+	instagram:
+		'<path d="M17.3 5.5a1.2 1.2 0 1 0 1.2 1.2 1.2 1.2 0 0 0-1.2-1.2ZM22 7.9a7.6 7.6 0 0 0-.4-2.5 5 5 0 0 0-1.2-1.7 4.7 4.7 0 0 0-1.8-1.2 7.3 7.3 0 0 0-2.4-.4L12 2H7.9a7.3 7.3 0 0 0-2.5.5 4.8 4.8 0 0 0-1.7 1.2 4.7 4.7 0 0 0-1.2 1.8 7.3 7.3 0 0 0-.4 2.4L2 12v4.1a7.3 7.3 0 0 0 .5 2.4 4.7 4.7 0 0 0 1.2 1.8 4.8 4.8 0 0 0 1.8 1.2 7.3 7.3 0 0 0 2.4.4l4.1.1h4.1a7.3 7.3 0 0 0 2.4-.5 4.7 4.7 0 0 0 1.8-1.2 4.8 4.8 0 0 0 1.2-1.7 7.6 7.6 0 0 0 .4-2.5L22 12V7.9ZM20.1 16a5.6 5.6 0 0 1-.3 1.9A3 3 0 0 1 19 19a3.2 3.2 0 0 1-1.1.8 5.6 5.6 0 0 1-1.9.3H8a5.7 5.7 0 0 1-1.9-.3A3.3 3.3 0 0 1 5 19a3 3 0 0 1-.7-1.1 5.5 5.5 0 0 1-.4-1.9l-.1-4V8a5.5 5.5 0 0 1 .4-1.9A3 3 0 0 1 5 5a3.1 3.1 0 0 1 1.1-.8A5.7 5.7 0 0 1 8 3.9l4-.1h4a5.6 5.6 0 0 1 1.9.4A3 3 0 0 1 19 5a3 3 0 0 1 .7 1.1A5.6 5.6 0 0 1 20 8l.1 4v4ZM12 6.9a5.1 5.1 0 1 0 5.1 5.1A5.1 5.1 0 0 0 12 6.9Zm0 8.4a3.3 3.3 0 1 1 3.3-3.3 3.3 3.3 0 0 1-3.3 3.3Z"/>',
 };

package/components/SocialIcons.astro

@@ -19,6 +19,7 @@ const labels: Record<Platform, string> = {
 	linkedin: 'LinkedIn',
 	twitch: 'Twitch',
 	microsoftTeams: 'Microsoft Teams',
+	instagram: 'Instagram',
 };
 
 const links = Object.entries(config.social || {}).filter(([, url]) => Boolean(url)) as [

package/components/TableOfContents/MobileTableOfContents.astro

@@ -35,6 +35,7 @@ const t = useTranslations(locale);
 <style>
 	nav {
 		position: fixed;
+		z-index: var(--sl-z-index-toc);
 		top: calc(var(--sl-nav-height) - 1px);
 		inset-inline: 0;
 		border-top: 1px solid var(--sl-color-gray-5);

package/components/TableOfContents/TableOfContentsList.astro

@@ -14,7 +14,7 @@ const { toc, isMobile = false, depth = 0 } = Astro.props;
 	{
 		toc.map((heading) => (
 			<li>
-				<a href={'#' + heading.slug} aria-current={heading.current && 'true'}>
+				<a href={'#' + heading.slug}>
 					<span>{heading.text}</span>
 				</a>
 				{heading.children.length > 0 && (

package/components/TableOfContents/generateToC.ts

@@ -2,7 +2,6 @@ import type { MarkdownHeading } from 'astro';
 
 export interface TocItem extends MarkdownHeading {
 	children: TocItem[];
-	current?: boolean;
 }
 
 function diveChildren(item: TocItem, depth: number): TocItem[] {
@@ -34,7 +33,7 @@ export function generateToC(
 
 	for (const heading of headings) {
 		if (toc.length === 0) {
-			toc.push({ ...heading, children: [], current: true });
+			toc.push({ ...heading, children: [] });
 		} else {
 			const lastItemInToc = toc.at(-1)!;
 			if (heading.depth < lastItemInToc.depth) {

package/index.ts

@@ -8,6 +8,7 @@ import { starlightSitemap } from './integrations/sitemap';
 import { vitePluginStarlightUserConfig } from './integrations/virtual-user-config';
 import { errorMap } from './utils/error-map';
 import { StarlightConfigSchema, StarlightUserConfig } from './utils/user-config';
+import { rehypeRtlCodeSupport } from './integrations/code-rtl-support';
 
 export default function StarlightIntegration(opts: StarlightUserConfig): AstroIntegration[] {
 	const parsedConfig = StarlightConfigSchema.safeParse(opts, { errorMap });
@@ -39,6 +40,7 @@ export default function StarlightIntegration(opts: StarlightUserConfig): AstroIn
 					},
 					markdown: {
 						remarkPlugins: [...starlightAsides()],
+						rehypePlugins: [rehypeRtlCodeSupport()],
 						shikiConfig:
 							// Configure Shiki theme if the user is using the default github-dark theme.
 							config.markdown.shikiConfig.theme !== 'github-dark' ? {} : { theme: 'css-variables' },

package/integrations/code-rtl-support.ts

@@ -0,0 +1,31 @@
+import type { Root } from 'hastscript/lib/core';
+import { CONTINUE, SKIP, visit } from 'unist-util-visit';
+
+/**
+ * rehype plugin that adds `dir` attributes to `<code>` and `<pre>`
+ * elements that don’t already have them.
+ *
+ * `<code>` will become `<code dir="auto">`
+ * `<pre>` will become `<pre dir="ltr">`
+ *
+ * `<code>` _inside_ `<pre>` is skipped, so respects the `ltr` on its parent.
+ *
+ * Reasoning:
+ * - `<pre>` is usually a code block and code should be LTR even in an RTL document
+ * - `<code>` is often LTR, but could also be RTL. `dir="auto"` ensures the bidirectional
+ *   algorithm treats the contents of `<code>` in isolation and gives its best guess.
+ */
+export function rehypeRtlCodeSupport() {
+	return () => (root: Root) => {
+		visit(root, 'element', (el) => {
+			if (el.tagName === 'pre' || el.tagName === 'code') {
+				el.properties ||= {};
+				if (!('dir' in el.properties)) {
+					el.properties.dir = { pre: 'ltr', code: 'auto' }[el.tagName];
+				}
+				return SKIP;
+			}
+			return CONTINUE;
+		});
+	};
+}

package/layout/TwoColumnContent.astro

@@ -18,6 +18,10 @@ interface Props {
 </div>
 
 <style>
+	.main-pane {
+		isolation: isolate;
+	}
+
 	@media (min-width: 72rem) {
 		.right-sidebar-container {
 			order: 2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",

package/style/props.css

@@ -104,6 +104,7 @@
 	--sl-outline-offset-inside: -0.1875rem;
 
 	/* Global z-index values */
+	--sl-z-index-toc: 4;
 	--sl-z-index-menu: 5;
 	--sl-z-index-navbar: 10;
 	--sl-z-index-skiplink: 20;

package/translations/fa.json

@@ -0,0 +1,22 @@
+{
+  "skipLink.label": "رفتن به محتوا",
+  "search.label": "جستجو",
+  "search.shortcutLabel": "(برای جستجو / را فشار دهید)",
+  "search.cancelLabel": "لغو",
+  "search.devWarning": "جستجو تنها در نسخه‌های تولیدی در دسترس است. \nسعی کنید سایت را بسازید و پیش‌نمایش آن را به صورت محلی آزمایش کنید.",
+  "themeSelect.accessibleLabel": "انتخاب پوسته",
+  "themeSelect.dark": "تیره",
+  "themeSelect.light": "روشن",
+  "themeSelect.auto": "خودکار",
+  "languageSelect.accessibleLabel": "انتخاب زبان",
+  "menuButton.accessibleLabel": "منو",
+  "sidebarNav.accessibleLabel": "اصلی",
+  "tableOfContents.onThisPage": "در این صفحه",
+  "tableOfContents.overview": "بررسی اجمالی",
+  "i18n.untranslatedContent": "این محتوا هنوز به زبان شما در دسترس نیست.",
+  "page.editLink": "ویرایش صفحه",
+  "page.lastUpdated": "آخرین به روز رسانی:",
+  "page.previousLink": "قبلی",
+  "page.nextLink": "بعدی",
+  "404.text": "صفحه یافت نشد. لطفاً URL را بررسی کنید یا از جستجو استفاده نمایید."
+}

package/translations/index.ts

@@ -5,6 +5,7 @@ import es from './es.json';
 import de from './de.json';
 import ja from './ja.json';
 import pt from './pt.json';
+import fa from './fa.json';
 import fr from './fr.json';
 import it from './it.json';
 import nl from './nl.json';
@@ -13,12 +14,13 @@ import tr from './tr.json';
 import ar from './ar.json';
 import nb from './nb.json';
 import zh from './zh.json';
+import ko from './ko.json';
+import sv from './sv.json';
 
 const { parse } = builtinI18nSchema();
 
 export default Object.fromEntries(
-	Object.entries({ cs, en, es, de, ja, pt, fr, it, nl, da, tr, ar, nb, zh }).map(([key, dict]) => [
-		key,
-		parse(dict),
-	])
+	Object.entries({ cs, en, es, de, ja, pt, fa, fr, it, nl, da, tr, ar, nb, zh, ko, sv }).map(
+		([key, dict]) => [key, parse(dict)]
+	)
 );

package/translations/ko.json

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

package/translations/sv.json

@@ -0,0 +1,22 @@
+{
+  "skipLink.label": "Hoppa till innehåll",
+  "search.label": "Sök",
+  "search.shortcutLabel": "(Tryck / för att söka)",
+  "search.cancelLabel": "Avbryt",
+  "search.devWarning": "Sökfunktionen är endast tillgänglig i produktionsbyggen. \nProva att bygga och förhandsvisa siten för att testa det lokalt.",
+  "themeSelect.accessibleLabel": "Välj tema",
+  "themeSelect.dark": "Mörkt",
+  "themeSelect.light": "Ljust",
+  "themeSelect.auto": "Auto",
+  "languageSelect.accessibleLabel": "Välj språk",
+  "menuButton.accessibleLabel": "Meny",
+  "sidebarNav.accessibleLabel": "Huvudmeny",
+  "tableOfContents.onThisPage": "På den här sidan",
+  "tableOfContents.overview": "Översikt",
+  "i18n.untranslatedContent": "Det här innehållet är inte tillgängligt på ditt språk än.",
+  "page.editLink": "Redigera sida",
+  "page.lastUpdated": "Senast uppdaterad:",
+  "page.previousLink": "Föregående",
+  "page.nextLink": "Nästa",
+  "404.text": "Sidan hittades inte. Kontrollera URL:n eller testa att använda sökfältet."
+}

package/utils/user-config.ts

@@ -147,6 +147,7 @@ const UserConfigSchema = z.object({
 				'linkedin',
 				'twitch',
 				'microsoftTeams',
+				'instagram',
 			]),
 			// Link to the respective social profile for this site
 			z.string().url()