starlight-obsidian 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # starlight-obsidian
 
+## 0.14.0
+
+### Minor Changes
+
+- [#77](https://github.com/HiDeoo/starlight-obsidian/pull/77) [`5818330`](https://github.com/HiDeoo/starlight-obsidian/commit/5818330456dd11d03f9787f4d9b6a4e68359d02d) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v7, drops support for Astro v6.
+
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.41.0`.
+
+  Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs%2Fstarlight%400.41.0) to update your project.
+
+- [#77](https://github.com/HiDeoo/starlight-obsidian/pull/77) [`5818330`](https://github.com/HiDeoo/starlight-obsidian/commit/5818330456dd11d03f9787f4d9b6a4e68359d02d) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for the Sätteri Markdown processor.
+
 ## 0.13.0
 
 ### Minor Changes

package/index.ts

@@ -4,10 +4,10 @@ import type { StarlightPlugin, StarlightUserConfig } from '@astrojs/starlight/ty
 import type { AstroIntegrationLogger } from 'astro'
 import { z } from 'astro/zod'
 
+import { throwPluginError } from './libs/error'
 import { starlightObsidianIntegration } from './libs/integration'
 import { getObsidianPaths, getVault } from './libs/obsidian'
 import { stripLeadingAndTrailingSlashes } from './libs/path'
-import { throwUserError } from './libs/plugin'
 import {
   addObsidianFiles,
   getSidebarEntriesPlaceholder,
@@ -158,7 +158,7 @@ function makeStarlightObsidianPlugin(
       })
 
       if (isUsingRemovedSidebarGroupConfig) {
-        throwUserError(
+        throwPluginError(
           'The `sidebar.label` and `sidebar.collapsed` options have been removed.',
           'Create a group in your Starlight sidebar configuration, set the `label` and `collapsed` options on that group, and add `obsidianSidebarEntries` to its `items` array.\nFor more information see https://starlight.astro.build/guides/sidebar/#groups',
         )
@@ -169,13 +169,13 @@ function makeStarlightObsidianPlugin(
       )
 
       if (isUsingDeprecatedCopyStarlightFrontmatter) {
-        throwUserError(
+        throwPluginError(
           'The `copyStarlightFrontmatter` option has been deprecated in favor of the `copyFrontmatter` option.',
           'For more information see https://starlight-obsidian.vercel.app/configuration/#copyfrontmatter',
         )
       }
 
-      throwUserError(
+      throwPluginError(
         `Invalid starlight-obsidian configuration:
 
 ${z.prettifyError(parsedConfig.error)}
@@ -231,7 +231,7 @@ ${z.prettifyError(parsedConfig.error)}
             } catch (error) {
               logger.error(error instanceof Error ? error.message : String(error))
 
-              throwUserError(`Failed to generate Starlight pages from Obsidian vault at '${config.vault}'.`)
+              throwPluginError(`Failed to generate Starlight pages from Obsidian vault at '${config.vault}'.`)
             }
           }
 

package/libs/{plugin.ts → error.ts}

@@ -1,6 +1,6 @@
 import { AstroError } from 'astro/errors'
 
-export function throwUserError(message: string, hint?: string): never {
+export function throwPluginError(message: string, hint?: string): never {
   throw new AstroError(
     message,
     hint ??

package/libs/integration.ts

@@ -1,23 +1,18 @@
 import type { AstroIntegration } from 'astro'
-import rehypeKatex from 'rehype-katex'
-import remarkMath from 'remark-math'
 
 import type { StarlightObsidianConfig } from '..'
 
-import { rehypeStarlightObsidian } from './rehype'
+import { applyMarkdownPlugin } from './processor'
 import { vitePluginStarlightObsidianConfig } from './vite'
 
 export function starlightObsidianIntegration(config: StarlightObsidianConfig): AstroIntegration {
   return {
     name: 'starlight-obsidian-integration',
     hooks: {
-      'astro:config:setup': ({ updateConfig }) => {
-        updateConfig({
-          markdown: {
-            rehypePlugins: [rehypeStarlightObsidian, rehypeKatex],
+      'astro:config:setup': ({ config: astroConfig, updateConfig }) => {
+        applyMarkdownPlugin(astroConfig.markdown.processor, config)
 
-            remarkPlugins: [[remarkMath, { singleDollarTextMath: config.math.singleDollarTextMath }]],
-          },
+        updateConfig({
           vite: {
             plugins: [vitePluginStarlightObsidianConfig(config)],
           },

package/libs/markdown.ts

@@ -1,3 +1,5 @@
+import type { ElementContent } from 'hast'
+import type { Literal } from 'mdast'
 import { fromMarkdown } from 'mdast-util-from-markdown'
 import { remark } from 'remark'
 import remarkFrontmatter from 'remark-frontmatter'
@@ -7,6 +9,8 @@ import { VFile } from 'vfile'
 
 import { remarkStarlightObsidian, type TransformContext } from './remark'
 
+const blockIdentifierRegex = /(?<identifier> *\^(?<name>[\w-]+))$/
+
 let processor: ReturnType<typeof remark> | undefined
 
 export async function transformMarkdownToString(
@@ -49,9 +53,34 @@ function getVFile(filePath: string, markdown: string, context: TransformContext)
   })
 }
 
+export function isNodeWithValue(node: ElementContent | undefined): node is NodeWithValue {
+  return node !== undefined && 'value' in node
+}
+
+export function getBlockIdentifier(node: NodeWithValue): { length: number; name: string } | undefined {
+  const match = blockIdentifierRegex.exec(node.value)
+  const identifier = match?.groups?.['identifier']
+  const name = match?.groups?.['name']
+
+  if (!identifier || !name) {
+    return undefined
+  }
+
+  return { length: identifier.length, name }
+}
+
+export function getLastContentChild(children: ElementContent[]) {
+  const index = children.findLastIndex((child) => child.type !== 'text' || child.value.trim().length > 0)
+  if (index === -1) return undefined
+
+  return { child: children[index], index }
+}
+
 interface TransformResult {
   aliases: string[] | undefined
   content: string
   skip: boolean
   type: 'markdown' | 'mdx'
 }
+
+export type NodeWithValue = ElementContent & Literal

package/libs/obsidian.ts

@@ -9,9 +9,9 @@ import yaml from 'yaml'
 
 import type { StarlightObsidianConfig } from '..'
 
+import { throwPluginError } from './error'
 import { isDirectory, isFile } from './fs'
 import { getExtension, isAnchor, slashify, slugifyPath, stripExtension } from './path'
-import { throwUserError } from './plugin'
 import { isAssetFile } from './starlight'
 
 const obsidianAppConfigSchema = z.object({
@@ -48,11 +48,11 @@ export async function getVault(config: StarlightObsidianConfig): Promise<Vault>
   const vaultPath = path.resolve(config.vault)
 
   if (!(await isDirectory(vaultPath))) {
-    throwUserError(`The provided vault path is not a directory.\n> Provided path: ${vaultPath}`)
+    throwPluginError(`The provided vault path is not a directory.\n> Provided path: ${vaultPath}`)
   }
 
   if (!(await isVaultDirectory(config, vaultPath))) {
-    throwUserError(
+    throwPluginError(
       `The provided vault path is not a valid Obsidian vault directory and does not include an '.obsidian/app.json' file.\n> Provided path: ${vaultPath}`,
     )
   }

package/libs/processor.ts

@@ -0,0 +1,68 @@
+import { katex as satteriKatex } from '@nullpinter/satteri-katex'
+import type { AstroConfig } from 'astro'
+import rehypeKatex from 'rehype-katex'
+import remarkMath from 'remark-math'
+
+import type { StarlightObsidianConfig } from '..'
+
+import { throwPluginError } from './error'
+import { rehypeStarlightObsidian } from './rehype'
+import { satteriStarlightObsidian } from './satteri'
+
+export function applyMarkdownPlugin(processor: MarkdownProcessor, config: StarlightObsidianConfig) {
+  if (isSatteriProcessor(processor)) {
+    processor.options.features ??= {}
+    processor.options.features.math = {
+      ...(typeof processor.options.features.math === 'object' ? processor.options.features.math : {}),
+      singleDollarTextMath: config.math.singleDollarTextMath,
+    }
+
+    processor.options.mdastPlugins.push(satteriKatex())
+    processor.options.hastPlugins.push(satteriStarlightObsidian)
+  } else if (isUnifiedProcessor(processor)) {
+    processor.options.remarkPlugins.push([remarkMath, { singleDollarTextMath: config.math.singleDollarTextMath }])
+    processor.options.rehypePlugins.push([rehypeStarlightObsidian], [rehypeKatex])
+  } else {
+    throwPluginError("The configured 'markdown.processor' is not supported by the starlight-obsidian plugin.")
+  }
+}
+
+function isSatteriProcessor(processor: unknown): processor is SatteriMarkdownProcessor {
+  if (typeof processor !== 'object' || processor === null) return false
+  const candidate = processor as { name?: unknown; options?: { hastPlugins?: unknown; mdastPlugins?: unknown[] } }
+  return (
+    candidate.name === 'satteri' &&
+    Array.isArray(candidate.options?.hastPlugins) &&
+    Array.isArray(candidate.options.mdastPlugins)
+  )
+}
+
+function isUnifiedProcessor(processor: unknown): processor is UnifiedMarkdownProcessor {
+  if (typeof processor !== 'object' || processor === null) return false
+  const candidate = processor as { name?: unknown; options?: { rehypePlugins?: unknown; remarkPlugins?: unknown[] } }
+  return (
+    candidate.name === 'unified' &&
+    Array.isArray(candidate.options?.rehypePlugins) &&
+    Array.isArray(candidate.options.remarkPlugins)
+  )
+}
+
+type MarkdownProcessor = NonNullable<AstroConfig['markdown']['processor']>
+
+interface SatteriMarkdownProcessor {
+  name: string
+  options: { features?: SatteriFeatures; hastPlugins: unknown[]; mdastPlugins: unknown[] }
+}
+
+interface SatteriFeatures {
+  math?:
+    | boolean
+    | {
+        singleDollarTextMath?: boolean
+      }
+}
+
+interface UnifiedMarkdownProcessor {
+  name: string
+  options: { rehypePlugins: unknown[]; remarkPlugins: unknown[] }
+}

package/libs/rehype.ts

@@ -1,8 +1,7 @@
 import type { Element, ElementContent, Root } from 'hast'
-import type { Literal } from 'mdast'
 import { CONTINUE, SKIP, visit } from 'unist-util-visit'
 
-const blockIdentifierRegex = /(?<identifier> *\^(?<name>[\w-]+))$/
+import { getBlockIdentifier, getLastContentChild, isNodeWithValue } from './markdown'
 
 export function rehypeStarlightObsidian() {
   return function transformer(tree: Root) {
@@ -12,7 +11,7 @@ export function rehypeStarlightObsidian() {
       // Handle blockqoutes first as they are block which can contain paragraphs or list items and we want to hoist
       // the IDs to the blockquote element.
       if (node.tagName === 'blockquote') {
-        const lastChild = node.children.at(-1)
+        const lastChild = getLastContentChild(node.children)?.child
 
         if (
           lastChild?.type !== 'element' ||
@@ -21,15 +20,15 @@ export function rehypeStarlightObsidian() {
           return CONTINUE
         }
 
-        const lastGrandChild = lastChild.children.at(-1)
+        const lastGrandChild = getLastContentChild(lastChild.children)?.child
 
         if (lastChild.tagName === 'p') {
           return transformBlockIdentifier(node, lastGrandChild)
         } else if (lastGrandChild?.type === 'element' && lastGrandChild.tagName === 'li') {
-          return transformBlockIdentifier(node, lastGrandChild.children.at(-1))
+          return transformBlockIdentifier(node, getLastContentChild(lastGrandChild.children)?.child)
         }
       } else if (node.tagName === 'p' || node.tagName === 'li') {
-        return transformBlockIdentifier(node, node.children.at(-1))
+        return transformBlockIdentifier(node, getLastContentChild(node.children)?.child)
       }
 
       return CONTINUE
@@ -42,7 +41,7 @@ function transformBlockIdentifier(reference: Element, node: ElementContent | und
     return CONTINUE
   }
 
-  const identifier = getBlockIdentifer(node)
+  const identifier = getBlockIdentifier(node)
 
   if (!identifier) {
     return CONTINUE
@@ -53,21 +52,3 @@ function transformBlockIdentifier(reference: Element, node: ElementContent | und
 
   return SKIP
 }
-
-function isNodeWithValue(node: ElementContent | undefined): node is NodeWithValue {
-  return node !== undefined && 'value' in node
-}
-
-function getBlockIdentifer(node: NodeWithValue): { length: number; name: string } | undefined {
-  const match = blockIdentifierRegex.exec(node.value)
-  const identifier = match?.groups?.['identifier']
-  const name = match?.groups?.['name']
-
-  if (!identifier || !name) {
-    return undefined
-  }
-
-  return { length: identifier.length, name }
-}
-
-type NodeWithValue = ElementContent & Literal

package/libs/satteri.ts

@@ -0,0 +1,86 @@
+import type { Element, ElementContent, Parents } from 'hast'
+import { defineHastPlugin, type HastPluginDefinition, type HastVisitorContext } from 'satteri'
+
+import { getBlockIdentifier, getLastContentChild, isNodeWithValue } from './markdown'
+
+export function satteriStarlightObsidian(): HastPluginDefinition {
+  return defineHastPlugin({
+    name: 'starlight-obsidian',
+    element: {
+      filter: ['blockquote', 'p', 'li'],
+      visit(node, ctx) {
+        if (node.tagName === 'blockquote') {
+          const lastChild = getLastContentChild(node.children)?.child
+
+          if (
+            lastChild?.type !== 'element' ||
+            !(lastChild.tagName === 'p' || lastChild.tagName === 'ul' || lastChild.tagName === 'ol')
+          ) {
+            return
+          }
+
+          const lastGrandChild = getLastContentChild(lastChild.children)?.child
+
+          if (lastChild.tagName === 'p') {
+            transformBlockIdentifier(node, lastGrandChild, ctx)
+          } else if (lastGrandChild?.type === 'element' && lastGrandChild.tagName === 'li') {
+            transformBlockIdentifier(node, getLastContentChild(lastGrandChild.children)?.child, ctx)
+          }
+        } else if (node.tagName === 'p' || node.tagName === 'li') {
+          if (isInsideBlockquoteWithIdentifier(node, ctx)) return
+
+          transformBlockIdentifier(node, getLastContentChild(node.children)?.child, ctx)
+        }
+      },
+    },
+  })
+}
+
+function transformBlockIdentifier(reference: Element, node: ElementContent | undefined, ctx: HastVisitorContext) {
+  if (!isNodeWithValue(node)) return
+
+  const identifier = getBlockIdentifier(node)
+  if (!identifier) return
+
+  ctx.setProperty(node, 'value', node.value.slice(0, identifier.length * -1))
+  ctx.setProperty(reference, 'id', `block-${identifier.name}`)
+}
+
+function isInsideBlockquoteWithIdentifier(node: Element, ctx: HastVisitorContext) {
+  let parent: Parents | undefined = ctx.parent(node)
+
+  while (parent !== undefined) {
+    if (parent.type === 'element' && parent.tagName === 'blockquote') {
+      return blockquoteHasIdentifier(parent)
+    }
+
+    parent = ctx.parent(parent)
+  }
+
+  return false
+}
+
+function blockquoteHasIdentifier(blockquote: Element) {
+  const lastChild = getLastContentChild(blockquote.children)?.child
+
+  if (
+    lastChild?.type !== 'element' ||
+    !(lastChild.tagName === 'p' || lastChild.tagName === 'ul' || lastChild.tagName === 'ol')
+  ) {
+    return false
+  }
+
+  const lastGrandChild = getLastContentChild(lastChild.children)?.child
+
+  if (lastChild.tagName === 'p') {
+    return isNodeWithValue(lastGrandChild) && getBlockIdentifier(lastGrandChild) !== undefined
+  }
+
+  if (lastGrandChild?.type !== 'element' || lastGrandChild.tagName !== 'li') {
+    return false
+  }
+
+  const lastListItemChild = getLastContentChild(lastGrandChild.children)?.child
+
+  return isNodeWithValue(lastListItemChild) && getBlockIdentifier(lastListItemChild) !== undefined
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -19,6 +19,7 @@
   "dependencies": {
     "@astro-community/astro-embed-twitter": "^0.5.11",
     "@astro-community/astro-embed-youtube": "^0.5.10",
+    "@nullpinter/satteri-katex": "^0.1.2",
     "decode-uri-component": "^0.4.1",
     "github-slugger": "^2.0.0",
     "globby": "^16.1.1",
@@ -35,6 +36,7 @@
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
+    "satteri": "^0.9.3",
     "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
     "yaml": "^2.8.2"
@@ -48,7 +50,7 @@
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.39.0"
+    "@astrojs/starlight": ">=0.41.0"
   },
   "engines": {
     "node": ">=22.12.0"