@astrojs/starlight 0.5.4 → 0.5.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @astrojs/starlight
 
+## 0.5.6
+
+### Patch Changes
+
+- [#383](https://github.com/withastro/starlight/pull/383) [`0ebc47e`](https://github.com/withastro/starlight/commit/0ebc47e52dc420240c8cb724c01f98dc22bdfc60) Thanks [@delucis](https://github.com/delucis)! - Fix edge case where index files in an index directory would end up with the wrong slug
+
+- [#373](https://github.com/withastro/starlight/pull/373) [`308b3aa`](https://github.com/withastro/starlight/commit/308b3aaeb0122af81a12514a81e160910f93d7a7) Thanks [@lorenzolewis](https://github.com/lorenzolewis)! - Fix visual overflow for wide logos
+
+- [#385](https://github.com/withastro/starlight/pull/385) [`fb35397`](https://github.com/withastro/starlight/commit/fb35397f107f7bbb2cb4929b7837f105f565a659) Thanks [@lorenzolewis](https://github.com/lorenzolewis)! - Fix nested elements in markdown content
+
+- [#386](https://github.com/withastro/starlight/pull/386) [`e6f6f30`](https://github.com/withastro/starlight/commit/e6f6f304437203d5ee6770092ac79063448b821f) Thanks [@huijing](https://github.com/huijing)! - Prevent search keyboard shortcuts from triggering when input elements are focused
+
+## 0.5.5
+
+### Patch Changes
+
+- [`a161c05`](https://github.com/withastro/starlight/commit/a161c05b74d2300c1fe49bfd8e111cc45c9a5bff) Thanks [@delucis](https://github.com/delucis)! - Fix missing metadata required for `astro add` support
+
 ## 0.5.4
 
 ### Patch Changes

package/components/Header.astro

@@ -57,14 +57,11 @@ const { locale } = Astro.props;
       );
       display: grid;
       grid-template-columns:
-        /* 1 (site title): runs up until the main content column’s left edge.  */
-        max(
-          var(--sl-title-min-width),
-          calc(
+        /* 1 (site title): runs up until the main content column’s left edge or the width of the title, whichever is the largest  */
+        minmax(calc(
             var(--__sidebar-width) +
               max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))
-          )
-        )
+          ), auto)
         /* 2 (search box): all free space that is available. */
         1fr
         /* 3 (right items): use the space that these need. */

package/components/MarkdownContent.astro

@@ -2,7 +2,7 @@
 
 <style>
   .content
-    > :global(
+    :global(
       :not(a, strong, em, del, span, input)
         + :not(a, strong, em, del, span, input, :where(.not-content *))
     ) {

package/components/Search.astro

@@ -96,10 +96,13 @@ const pagefindTranslations = {
 
       // Listen for `/` and `cmd + k` keyboard shortcuts.
       window.addEventListener('keydown', (e) => {
+        const isInput =
+          document.activeElement &&
+          ['input', 'select', 'textarea'].includes(document.activeElement.tagName.toLowerCase());
         if (e.metaKey === true && e.key === 'k') {
           dialog.open ? closeModal() : openModal();
           e.preventDefault();
-        } else if (e.key === '/' && !dialog.open) {
+        } else if (e.key === '/' && !dialog.open && !isInput) {
           openModal();
           e.preventDefault();
         }

package/index.ts

@@ -1,21 +1,16 @@
 import mdx from '@astrojs/mdx';
-import type {
-  AstroConfig,
-  AstroIntegration,
-  AstroUserConfig,
-  ViteUserConfig,
-} from 'astro';
+import type { AstroIntegration, AstroUserConfig } from 'astro';
 import { spawn } from 'node:child_process';
-import { dirname, relative, resolve } from 'node:path';
+import { dirname, relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { starlightAsides } from './integrations/asides';
 import { starlightSitemap } from './integrations/sitemap';
+import { vitePluginStarlightUserConfig } from './integrations/virtual-user-config';
+import { errorMap } from './utils/error-map';
 import {
-  StarlightUserConfig,
-  StarlightConfig,
   StarlightConfigSchema,
+  StarlightUserConfig,
 } from './utils/user-config';
-import { errorMap } from './utils/error-map';
 
 export default function StarlightIntegration(
   opts: StarlightUserConfig
@@ -78,47 +73,3 @@ export default function StarlightIntegration(
 
   return [starlightSitemap(userConfig), Starlight, mdx()];
 }
-
-function resolveVirtualModuleId(id: string) {
-  return '\0' + id;
-}
-
-/** Expose the Starlight user config object via a virtual module. */
-function vitePluginStarlightUserConfig(
-  opts: StarlightConfig,
-  { root }: AstroConfig
-): NonNullable<ViteUserConfig['plugins']>[number] {
-  const resolveRelativeId = (id: string) =>
-    JSON.stringify(id.startsWith('.') ? resolve(fileURLToPath(root), id) : id);
-  const modules = {
-    'virtual:starlight/user-config': `export default ${JSON.stringify(opts)}`,
-    'virtual:starlight/project-context': `export default ${JSON.stringify({
-      root,
-    })}`,
-    'virtual:starlight/user-css': opts.customCss
-      .map((id) => `import ${resolveRelativeId(id)};`)
-      .join(''),
-    'virtual:starlight/user-images': opts.logo
-      ? 'src' in opts.logo
-        ? `import src from ${resolveRelativeId(opts.logo.src)}; export const logos = { dark: src, light: src };`
-        : `import dark from ${resolveRelativeId(opts.logo.dark)}; import light from ${resolveRelativeId(opts.logo.light)}; export const logos = { dark, light };`
-      : 'export const logos = {};',
-  };
-  const resolutionMap = Object.fromEntries(
-    (Object.keys(modules) as (keyof typeof modules)[]).map((key) => [
-      resolveVirtualModuleId(key),
-      key,
-    ])
-  );
-
-  return {
-    name: 'vite-plugin-starlight-user-config',
-    resolveId(id): string | void {
-      if (id in modules) return resolveVirtualModuleId(id);
-    },
-    load(id): string | void {
-      const resolution = resolutionMap[id];
-      if (resolution) return modules[resolution];
-    },
-  };
-}

package/integrations/virtual-user-config.ts

@@ -0,0 +1,52 @@
+import type { AstroConfig, ViteUserConfig } from 'astro';
+import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import type { StarlightConfig } from '../utils/user-config';
+
+function resolveVirtualModuleId<T extends string>(id: T): `\0${T}` {
+  return `\0${id}`;
+}
+
+/** Vite plugin that exposes Starlight user config and project context via virtual modules. */
+export function vitePluginStarlightUserConfig(
+  opts: StarlightConfig,
+  { root }: Pick<AstroConfig, 'root'>
+): NonNullable<ViteUserConfig['plugins']>[number] {
+  const resolveId = (id: string) =>
+    JSON.stringify(id.startsWith('.') ? resolve(fileURLToPath(root), id) : id);
+
+  /** Map of virtual module names to their code contents as strings. */
+  const modules = {
+    'virtual:starlight/user-config': `export default ${JSON.stringify(opts)}`,
+    'virtual:starlight/project-context': `export default ${JSON.stringify({ root })}`,
+    'virtual:starlight/user-css': opts.customCss.map((id) => `import ${resolveId(id)};`).join(''),
+    'virtual:starlight/user-images': opts.logo
+      ? 'src' in opts.logo
+        ? `import src from ${resolveId(
+            opts.logo.src
+          )}; export const logos = { dark: src, light: src };`
+        : `import dark from ${resolveId(opts.logo.dark)}; import light from ${resolveId(
+            opts.logo.light
+          )}; export const logos = { dark, light };`
+      : 'export const logos = {};',
+  } satisfies Record<string, string>;
+
+  /** Mapping names prefixed with `\0` to their original form. */
+  const resolutionMap = Object.fromEntries(
+    (Object.keys(modules) as (keyof typeof modules)[]).map((key) => [
+      resolveVirtualModuleId(key),
+      key,
+    ])
+  );
+
+  return {
+    name: 'vite-plugin-starlight-user-config',
+    resolveId(id): string | void {
+      if (id in modules) return resolveVirtualModuleId(id);
+    },
+    load(id): string | void {
+      const resolution = resolutionMap[id];
+      if (resolution) return modules[resolution];
+    },
+  };
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
     "documentation",
     "astro",
-    "withastro"
+    "withastro",
+    "astro-integration"
   ],
   "author": "Chris Swithinbank <swithinbank@gmail.com>",
   "license": "MIT",
@@ -31,7 +32,9 @@
   },
   "devDependencies": {
     "@types/node": "^18.16.19",
-    "astro": "^2.8.5"
+    "@vitest/coverage-v8": "^0.33.0",
+    "astro": "^2.8.5",
+    "vitest": "^0.33.0"
   },
   "dependencies": {
     "@astrojs/mdx": "^0.19.7",
@@ -50,5 +53,8 @@
     "unist-util-visit": "^4.1.2",
     "vfile": "^5.3.7"
   },
-  "scripts": {}
+  "scripts": {
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
 }

package/style/props.css

@@ -96,7 +96,6 @@
   --sl-nav-height: 3.5rem;
   --sl-nav-pad-x: 1rem;
   --sl-nav-pad-y: 0.75rem;
-  --sl-title-min-width: 10rem;
   --sl-mobile-toc-height: 3rem;
   --sl-sidebar-width: 18.75rem;
   --sl-sidebar-pad-x: 1rem;

package/types.ts

@@ -1 +1 @@
-export { StarlightConfig } from './utils/user-config';
+export type { StarlightConfig } from './utils/user-config';

package/utils/slugs.ts

@@ -56,7 +56,7 @@ export function slugToParam(slug: string): string | undefined {
   return slug === 'index' || slug === ''
     ? undefined
     : slug.endsWith('/index')
-    ? slug.replace('/index', '')
+    ? slug.replace(/\/index$/, '')
     : slug;
 }