starlight-obsidian 0.4.2 → 0.4.4

package/libs/markdown.ts

@@ -1,3 +1,4 @@
+import { fromMarkdown } from 'mdast-util-from-markdown'
 import { remark } from 'remark'
 import remarkFrontmatter from 'remark-frontmatter'
 import remarkGfm from 'remark-gfm'
@@ -23,8 +24,10 @@ export async function transformMarkdownToString(
   }
 }
 
-export function transformMarkdownToAST(filePath: string, markdown: string, context: TransformContext) {
-  return processor.parse(getVFile(filePath, markdown, context))
+export async function transformMarkdownToAST(filePath: string, markdown: string, context: TransformContext) {
+  const { content } = await transformMarkdownToString(filePath, markdown, context)
+
+  return fromMarkdown(content)
 }
 
 function getVFile(filePath: string, markdown: string, context: TransformContext) {

package/libs/obsidian.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs/promises'
 import path from 'node:path'
 
 import { z } from 'astro/zod'
+import decodeUriComponent from 'decode-uri-component'
 import { slug } from 'github-slugger'
 import { globby } from 'globby'
 import yaml from 'yaml'
@@ -45,11 +46,13 @@ 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.')
+    throwUserError(`The provided vault path is not a directory.\n> Provided path: ${vaultPath}`)
   }
 
   if (!(await isVaultDirectory(config, vaultPath))) {
-    throwUserError('The provided vault path is not a valid Obsidian vault directory.')
+    throwUserError(
+      `The provided vault path is not a valid Obsidian vault directory and does not include an '.obsidian/app.json' file.\n> Provided path: ${vaultPath}`,
+    )
   }
 
   const options = await getVaultOptions(config, vaultPath)
@@ -108,14 +111,14 @@ export function slugifyObsidianPath(obsidianPath: string) {
       const isLastSegment = index === segments.length - 1
 
       if (!isLastSegment) {
-        return slug(decodeURIComponent(segment))
+        return slug(decodeUriComponent(segment))
       } else if (isObsidianFile(segment) && !isAssetFile(segment)) {
-        return decodeURIComponent(segment)
+        return decodeUriComponent(segment)
       } else if (isAssetFile(segment)) {
-        return `${slug(decodeURIComponent(stripExtension(segment)))}${getExtension(segment)}`
+        return `${slug(decodeUriComponent(stripExtension(segment)))}${getExtension(segment)}`
       }
 
-      return slug(decodeURIComponent(stripExtension(segment)))
+      return slug(decodeUriComponent(stripExtension(segment)))
     })
     .join('/')
 }

package/libs/remark.ts

@@ -53,6 +53,7 @@ export function remarkStarlightObsidian() {
 
     handleReplacements(tree, file)
     await handleMermaid(tree, file)
+    await handleImagesAndNoteEmbeds(tree, file)
 
     visit(tree, (node, index, parent) => {
       const context: VisitorContext = { file, index, parent }
@@ -65,9 +66,6 @@ export function remarkStarlightObsidian() {
         case 'link': {
           return handleLinks(node, context)
         }
-        case 'image': {
-          return handleImages(node, context)
-        }
         case 'blockquote': {
           return handleBlockquotes(node, context)
         }
@@ -77,7 +75,10 @@ export function remarkStarlightObsidian() {
       }
     })
 
-    handleFrontmatter(tree, file, obsidianFrontmatter)
+    if (!file.data.embedded) {
+      handleFrontmatter(tree, file, obsidianFrontmatter)
+    }
+
     handleImports(tree, file)
   }
 }
@@ -275,7 +276,7 @@ function handleLinks(node: Link, { file }: VisitorContext) {
   return SKIP
 }
 
-function handleImages(node: Image, context: VisitorContext) {
+async function handleImages(node: Image, context: VisitorContext) {
   const { file } = context
 
   ensureTransformContext(file)
@@ -299,7 +300,7 @@ function handleImages(node: Image, context: VisitorContext) {
   }
 
   if (isMarkdownFile(node.url, file)) {
-    replaceNode(context, getMarkdownFileNode(file, node.url))
+    replaceNode(context, await getMarkdownFileNode(file, node.url))
     return SKIP
   }
 
@@ -419,6 +420,21 @@ async function handleMermaid(tree: Root, file: VFile) {
   )
 }
 
+async function handleImagesAndNoteEmbeds(tree: Root, file: VFile) {
+  const imageNodes: [node: Image, context: VisitorContext][] = []
+
+  visit(tree, 'image', (node, index, parent) => {
+    imageNodes.push([node, { file, index, parent }])
+    return SKIP
+  })
+
+  await Promise.all(
+    imageNodes.map(async ([node, context]) => {
+      await handleImages(node, context)
+    }),
+  )
+}
+
 function getFrontmatterNodeValue(file: VFile, obsidianFrontmatter?: ObsidianFrontmatter) {
   let frontmatter: Frontmatter = {
     title: file.stem,
@@ -587,7 +603,7 @@ function getCustomFileNode(filePath: string): RootContent {
   }
 }
 
-function getMarkdownFileNode(file: VFile, fileUrl: string): RootContent {
+async function getMarkdownFileNode(file: VFile, fileUrl: string): Promise<RootContent> {
   ensureTransformContext(file)
 
   const fileExt = file.data.vault.options.linkSyntax === 'wikilink' ? '.md' : ''
@@ -604,7 +620,7 @@ function getMarkdownFileNode(file: VFile, fileUrl: string): RootContent {
   }
 
   const content = fs.readFileSync(matchingFile.fsPath, 'utf8')
-  const root = transformMarkdownToAST(matchingFile.fsPath, content, file.data)
+  const root = await transformMarkdownToAST(matchingFile.fsPath, content, { ...file.data, embedded: true })
 
   return {
     type: 'blockquote',
@@ -644,6 +660,7 @@ export interface TransformContext {
   aliases?: string[]
   assetImports?: [id: string, path: string][]
   copyStarlightFrontmatter?: boolean
+  embedded?: boolean
   files: VaultFile[]
   includeKatexStyles?: boolean
   includeTwitterComponent?: boolean

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -20,6 +20,7 @@
     "@astro-community/astro-embed-twitter": "0.5.3",
     "@astro-community/astro-embed-youtube": "0.4.4",
     "@astrojs/markdown-remark": "4.2.1",
+    "decode-uri-component": "0.4.1",
     "github-slugger": "2.0.0",
     "globby": "14.0.0",
     "hast-util-to-html": "9.0.0",
@@ -28,6 +29,7 @@
     "html-escaper": "3.0.3",
     "is-absolute-url": "4.0.1",
     "mdast-util-find-and-replace": "3.0.1",
+    "mdast-util-from-markdown": "2.0.0",
     "mdast-util-to-hast": "13.1.0",
     "nanoid": "5.0.4",
     "rehype": "13.0.1",