starlight-versions 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # starlight-versions
 
+## 0.5.1
+
+### Patch Changes
+
+- [#21](https://github.com/HiDeoo/starlight-versions/pull/21) [`42be6e3`](https://github.com/HiDeoo/starlight-versions/commit/42be6e30a54fcdd5bec0959b7f354a1bc3954c14) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential link generation issue when using the Astro [`base`](https://docs.astro.build/en/reference/configuration-reference/#base) option.
+
 ## 0.5.0
 
 ### Minor Changes

package/index.ts

@@ -33,7 +33,7 @@ export default function starlightVersionsPlugin(userConfig: StarlightVersionsUse
         if (command !== 'dev' && command !== 'build') return
 
         try {
-          await ensureNewVersion(config, starlightConfig, astroConfig.srcDir, logger)
+          await ensureNewVersion(config, starlightConfig, astroConfig, logger)
         } catch (error) {
           throwPluginError(
             error instanceof Error ? error.message : 'An error occurred while creating a new documentation version.',

package/libs/markdown.ts

@@ -187,9 +187,20 @@ function handleImports(node: MdxjsEsm, file: VFile) {
 function addVersionToLink(link: string, file: VFile) {
   assert(file.data.version, 'A version must be provided to add a version to an Astro asset.')
 
+  const base = file.data.base ?? ''
+  const hasBase = file.data.base && link.startsWith(file.data.base)
+
+  if (hasBase) {
+    link = link.replace(base, '')
+  }
+
   const segments = link.split('/')
   segments.splice(1, 0, file.data.version.slug)
 
+  if (hasBase) {
+    segments.splice(1, 0, stripLeadingSlash(base))
+  }
+
   return segments.join('/')
 }
 
@@ -235,6 +246,7 @@ function isPublicAsset(asset: string) {
 
 export interface TransformContext {
   assets: VersionAsset[]
+  base: string
   locale: string | undefined
   slug: string
   url: URL

package/libs/versions.ts

@@ -1,5 +1,5 @@
 import type { StarlightConfig } from '@astrojs/starlight/types'
-import type { AstroIntegrationLogger } from 'astro'
+import type { AstroConfig, AstroIntegrationLogger } from 'astro'
 import { z } from 'astro/zod'
 
 import type { StarlightVersionsConfig } from '..'
@@ -55,10 +55,10 @@ export const VersionSchema = z
 export async function ensureNewVersion(
   config: StarlightVersionsConfig,
   starlightConfig: StarlightUserConfig,
-  srcDir: URL,
+  astroConfig: AstroConfig,
   logger: AstroIntegrationLogger,
 ) {
-  const docsDir = new URL('content/docs/', srcDir)
+  const docsDir = new URL('content/docs/', astroConfig.srcDir)
   const newVersion = await checkForNewVersion(config, docsDir)
   const locales = Object.keys(starlightConfig.locales ?? {})
 
@@ -98,6 +98,7 @@ export async function ensureNewVersion(
 
     const md = await transformMarkdown(entry.content, {
       assets: [],
+      base: stripTrailingSlash(astroConfig.base),
       locale: getDocLocale(slug, starlightConfig),
       slug,
       url: entry.url,
@@ -113,7 +114,7 @@ export async function ensureNewVersion(
     await copyFile(asset.source, asset.dest)
   }
 
-  await makeVersionConfig(newVersion, starlightConfig, srcDir)
+  await makeVersionConfig(newVersion, starlightConfig, astroConfig.srcDir)
 
   logger.info(`Created new version '${newVersion.slug}'.`)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-versions",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "license": "MIT",
   "description": "Starlight plugin to version documentation pages.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",