starlight-obsidian 0.1.1

package/libs/starlight.ts

@@ -0,0 +1,263 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+
+import type { StarlightUserConfig } from '@astrojs/starlight/types'
+import type { AstroIntegrationLogger } from 'astro'
+
+import type { StarlightObsidianConfig } from '..'
+
+import { copyFile, ensureDirectory, removeDirectory } from './fs'
+import { transformMarkdownToString } from './markdown'
+import { getObsidianVaultFiles, isObsidianFile, type Vault, type VaultFile } from './obsidian'
+import { getExtension } from './path'
+
+const assetsPath = 'src/assets'
+const docsPath = 'src/content/docs'
+const publicPath = 'public'
+
+const starlightObsidianSidebarGroupLabel = Symbol('StarlightObsidianSidebarGroupLabel')
+
+const obsidianToStarlightCalloutTypeMap: Record<string, string> = {
+  note: 'note',
+  abstract: 'tip',
+  summary: 'tip',
+  tldr: 'tip',
+  info: 'note',
+  todo: 'note',
+  tip: 'tip',
+  hint: 'tip',
+  important: 'tip',
+  success: 'note',
+  check: 'note',
+  done: 'note',
+  question: 'caution',
+  help: 'caution',
+  faq: 'caution',
+  warning: 'caution',
+  caution: 'caution',
+  attention: 'caution',
+  failure: 'danger',
+  fail: 'danger',
+  missing: 'danger',
+  danger: 'danger',
+  error: 'danger',
+  bug: 'danger',
+  example: 'tip',
+  quote: 'note',
+  cite: 'note',
+}
+
+export function getSidebarGroupPlaceholder(): SidebarManualGroup {
+  return {
+    items: [],
+    label: starlightObsidianSidebarGroupLabel.toString(),
+  }
+}
+
+export function getSidebarFromConfig(
+  config: StarlightObsidianConfig,
+  sidebar: StarlightUserConfig['sidebar'],
+): StarlightUserConfig['sidebar'] {
+  if (!sidebar || sidebar.length === 0) {
+    return sidebar
+  }
+
+  function replaceSidebarGroupPlaceholder(group: SidebarManualGroup): SidebarGroup {
+    if (group.label === starlightObsidianSidebarGroupLabel.toString()) {
+      return {
+        autogenerate: {
+          collapsed: config.sidebar.collapsedFolders ?? config.sidebar.collapsed,
+          directory: config.output,
+        },
+        collapsed: config.sidebar.collapsed,
+        label: config.sidebar.label,
+      }
+    }
+
+    if (isSidebarGroup(group)) {
+      return {
+        ...group,
+        items: group.items.map((item) => {
+          return isSidebarGroup(item) ? replaceSidebarGroupPlaceholder(item) : item
+        }),
+      }
+    }
+
+    return group
+  }
+
+  return sidebar.map((item) => {
+    return isSidebarGroup(item) ? replaceSidebarGroupPlaceholder(item) : item
+  })
+}
+
+export async function addObsidianFiles(
+  config: StarlightObsidianConfig,
+  vault: Vault,
+  obsidianPaths: string[],
+  logger: AstroIntegrationLogger,
+) {
+  const outputPaths = getOutputPaths(config)
+
+  await cleanOutputPaths(outputPaths)
+
+  const vaultFiles = getObsidianVaultFiles(vault, obsidianPaths)
+
+  const results = await Promise.allSettled(
+    vaultFiles.map(async (vaultFile) => {
+      await (vaultFile.type === 'asset'
+        ? addAsset(outputPaths, vaultFile)
+        : vaultFile.type === 'file'
+          ? addFile(outputPaths, vaultFile)
+          : addContent(config, vault, outputPaths, vaultFiles, vaultFile))
+    }),
+  )
+
+  let didFail = false
+
+  for (const result of results) {
+    if (result.status === 'rejected') {
+      didFail = true
+      logger.error(result.reason instanceof Error ? result.reason.message : String(result.reason))
+    }
+  }
+
+  if (didFail) {
+    throw new Error('Failed to generate some Starlight pages. See the error(s) above for more information.')
+  }
+}
+
+export function getStarlightCalloutType(obsidianCalloutType: string): string {
+  return obsidianToStarlightCalloutTypeMap[obsidianCalloutType] ?? 'note'
+}
+
+export function isAssetFile(filePath: string): boolean {
+  return getExtension(filePath) !== '.bmp' && isObsidianFile(filePath, 'image')
+}
+
+async function addContent(
+  config: StarlightObsidianConfig,
+  vault: Vault,
+  outputPaths: OutputPaths,
+  vaultFiles: VaultFile[],
+  vaultFile: VaultFile,
+) {
+  try {
+    const obsidianContent = await fs.readFile(vaultFile.fsPath, 'utf8')
+    const {
+      content: starlightContent,
+      aliases,
+      skip,
+      type,
+    } = await transformMarkdownToString(vaultFile.fsPath, obsidianContent, {
+      files: vaultFiles,
+      output: config.output,
+      vault,
+    })
+
+    if (skip) {
+      return
+    }
+
+    const starlightPath = path.join(
+      outputPaths.content,
+      type === 'markdown' ? vaultFile.path : vaultFile.path.replace(/\.md$/, '.mdx'),
+    )
+    const starlightDirPath = path.dirname(starlightPath)
+
+    await ensureDirectory(starlightDirPath)
+    await fs.writeFile(starlightPath, starlightContent)
+
+    if (aliases) {
+      for (const alias of aliases) {
+        await addAlias(config, outputPaths, vaultFile, alias)
+      }
+    }
+  } catch (error) {
+    throwVaultFileError(error, vaultFile)
+  }
+}
+
+async function addFile(outputPaths: OutputPaths, vaultFile: VaultFile) {
+  try {
+    await copyFile(vaultFile.fsPath, path.join(outputPaths.file, vaultFile.slug))
+  } catch (error) {
+    throwVaultFileError(error, vaultFile)
+  }
+}
+
+async function addAsset(outputPaths: OutputPaths, vaultFile: VaultFile) {
+  try {
+    await copyFile(vaultFile.fsPath, path.join(outputPaths.asset, vaultFile.slug))
+  } catch (error) {
+    throwVaultFileError(error, vaultFile)
+  }
+}
+
+async function addAlias(
+  config: StarlightObsidianConfig,
+  outputPaths: OutputPaths,
+  vaultFile: VaultFile,
+  alias: string,
+) {
+  const starlightPath = path.join(outputPaths.file, path.dirname(vaultFile.path), alias, 'index.html')
+  const starlightDirPath = path.dirname(starlightPath)
+
+  const to = path.posix.join(path.posix.sep, config.output, vaultFile.slug)
+  const from = path.posix.join(path.dirname(to), alias)
+
+  await ensureDirectory(starlightDirPath)
+
+  // Based on https://github.com/withastro/astro/blob/57ab578bc7bdac6c65c2315365c0e94bc98af2b3/packages/astro/src/core/build/generate.ts#L584-L591
+  // but tweaked to add an `<html>` element so that Pagefind does not emit a warning when ignoring the page.
+  await fs.writeFile(
+    starlightPath,
+    `<!doctype html>
+<html>
+  <head>
+    <title>Redirecting to: ${to}</title>
+    <meta http-equiv="refresh" content="0;url=${to}">
+    <meta name="robots" content="noindex">
+    <link rel="canonical" href="${to}">
+  </head>
+  <body>
+    <a href="${to}">Redirecting from <code>${from}</code> to "<code>${to}</code>"</a>
+  </body>
+</html>`,
+  )
+}
+
+function getOutputPaths(config: StarlightObsidianConfig): OutputPaths {
+  return {
+    asset: path.join(assetsPath, config.output),
+    content: path.join(docsPath, config.output),
+    file: path.join(publicPath, config.output),
+  }
+}
+
+async function cleanOutputPaths(outputPaths: OutputPaths) {
+  await removeDirectory(outputPaths.asset)
+  await removeDirectory(outputPaths.content)
+  await removeDirectory(outputPaths.file)
+}
+
+function throwVaultFileError(error: unknown, vaultFile: VaultFile): never {
+  throw new Error(`${vaultFile.path} — ${error instanceof Error ? error.message : String(error)}`, { cause: error })
+}
+
+function isSidebarGroup(item: SidebarGroup): item is SidebarManualGroup {
+  return 'items' in item
+}
+
+interface OutputPaths {
+  asset: string
+  content: string
+  file: string
+}
+
+interface SidebarManualGroup {
+  items: SidebarManualGroup[]
+  label: string
+}
+
+type SidebarGroup = NonNullable<StarlightUserConfig['sidebar']>[number]

package/overrides/PageTitle.astro

@@ -0,0 +1,14 @@
+---
+import Default from '@astrojs/starlight/components/PageTitle.astro'
+import type { Props } from '@astrojs/starlight/props'
+
+import Tags from '../components/Tags.astro'
+
+const { entry } = Astro.props
+
+const tags = entry['data']['tags']
+const showTags = tags !== undefined && tags.length > 0
+---
+
+<Default {...Astro.props}><slot /></Default>
+{showTags && <Tags {tags} />}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "starlight-obsidian",
+  "version": "0.1.1",
+  "license": "MIT",
+  "description": "Starlight plugin to publish Obsidian vaults.",
+  "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
+  "type": "module",
+  "exports": {
+    ".": "./index.ts",
+    "./components/Twitter.astro": "./components/Twitter.astro",
+    "./components/Youtube.astro": "./components/Youtube.astro",
+    "./overrides/PageTitle.astro": "./overrides/PageTitle.astro",
+    "./schema": "./schema.ts",
+    "./styles": "./styles.css",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@astro-community/astro-embed-twitter": "0.5.3",
+    "@astro-community/astro-embed-youtube": "0.4.4",
+    "github-slugger": "2.0.0",
+    "globby": "14.0.0",
+    "hast-util-to-html": "9.0.0",
+    "is-absolute-url": "4.0.1",
+    "mdast-util-find-and-replace": "3.0.1",
+    "mdast-util-to-hast": "13.1.0",
+    "nanoid": "5.0.4",
+    "rehype": "13.0.1",
+    "rehype-katex": "7.0.0",
+    "rehype-mermaid": "2.1.0",
+    "remark": "15.0.1",
+    "remark-frontmatter": "5.0.0",
+    "remark-gfm": "4.0.0",
+    "remark-math": "6.0.0",
+    "unist-util-visit": "5.0.0",
+    "vfile": "6.0.1",
+    "yaml": "2.3.4"
+  },
+  "devDependencies": {
+    "@astrojs/starlight": "0.16.0",
+    "@types/hast": "3.0.3",
+    "@types/mdast": "4.0.3",
+    "@types/unist": "3.0.2",
+    "astro": "4.2.1",
+    "typescript": "5.3.3",
+    "vitest": "1.2.1"
+  },
+  "peerDependencies": {
+    "@astrojs/starlight": ">=0.15.0",
+    "astro": ">=4.0.0"
+  },
+  "engines": {
+    "node": ">=18.14.1"
+  },
+  "packageManager": "pnpm@8.14.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "starlight",
+    "plugin",
+    "obsidian",
+    "vault",
+    "documentation",
+    "astro"
+  ],
+  "homepage": "https://github.com/HiDeoo/starlight-obsidian",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HiDeoo/starlight-obsidian.git"
+  },
+  "bugs": "https://github.com/HiDeoo/starlight-obsidian/issues",
+  "scripts": {
+    "test": "vitest",
+    "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
+  }
+}

package/schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'astro/zod'
+
+export const starlightObsidianSchema = () =>
+  z
+    .object({
+      tags: z.array(z.string()),
+    })
+    .partial()

package/styles.css

@@ -0,0 +1,42 @@
+:root {
+  --sl--bs-hue-yellow: 51;
+
+  --sl-obs-highlight: hsl(var(--sl--bs-hue-yellow), 71%, 56%);
+}
+
+:root[data-theme='light'] {
+  --sl-obs-highlight: hsl(var(--sl--bs-hue-yellow), 80%, 56%);
+}
+
+.sl-obs-highlight {
+  background-color: var(--sl-obs-highlight);
+}
+
+.sl-markdown-content .sl-obs-embed-audio {
+  width: 100%;
+}
+
+.sl-markdown-content .sl-obs-embed-pdf {
+  border: none;
+  height: 600px;
+  width: 100%;
+}
+
+.sl-obs-tag {
+  background-color: var(--sl-color-accent-low);
+  border-radius: 0.25rem;
+  border: 1px solid var(--sl-color-accent);
+  color: #fff;
+  font-family: var(--sl-font-system-mono);
+  font-size: var(--sl-text-xs);
+  padding: 0.25rem 0.375rem;
+}
+
+[data-theme='light'] .sl-obs-tag {
+  background-color: var(--sl-color-accent-high);
+}
+
+blockquote.twitter-tweet:not(.twitter-tweet-rendered) {
+  border: 1px solid var(--sl-color-gray-5);
+  margin-block: 1rem;
+}