starlight-obsidian 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # starlight-obsidian
 
+## 0.10.0
+
+### Minor Changes
+
+- [#61](https://github.com/HiDeoo/starlight-obsidian/pull/61) [`c4150ef`](https://github.com/HiDeoo/starlight-obsidian/commit/c4150ef713e327f218c5ee0023ba3831e51cfccd) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds a new configuration option `math.singleDollarTextMath` to control whether or not inline math expressions using single dollar signs should be supported or not.
+
+  This option can be useful to disable support for single dollar inline math expressions which can conflict with “normal” dollars in CommonMark.
+
+## 0.9.1
+
+### Patch Changes
+
+- [#56](https://github.com/HiDeoo/starlight-obsidian/pull/56) [`ff18bbd`](https://github.com/HiDeoo/starlight-obsidian/commit/ff18bbd6b2614e5e817fdca2005825ea1841e0a0) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential syntax issue when converting Obsidian vault files containing void elements to MDX format.
+
 ## 0.9.0
 
 ### Minor Changes

package/index.ts

@@ -45,6 +45,20 @@ const starlightObsidianConfigSchema = z.object({
    * @see https://help.obsidian.md/Files+and+folders/Accepted+file+formats
    */
   ignore: z.array(z.string()).default([]),
+  /**
+   * Configures math processing options.
+   */
+  math: z
+    .object({
+      /**
+       * Whether or not to support inline math expressions using single dollar signs.
+       *
+       * @default true
+       * @see https://github.com/micromark/micromark-extension-math/issues/6#issuecomment-1938838687
+       */
+      singleDollarTextMath: z.boolean().default(true),
+    })
+    .default({}),
   /**
    * The name of the output directory containing the generated Obsidian vault pages relative to the `src/content/docs/`
    * directory.

package/libs/integration.ts

@@ -15,7 +15,8 @@ export function starlightObsidianIntegration(config: StarlightObsidianConfig): A
         updateConfig({
           markdown: {
             rehypePlugins: [rehypeStarlightObsidian, rehypeKatex],
-            remarkPlugins: [remarkMath],
+
+            remarkPlugins: [[remarkMath, { singleDollarTextMath: config.math.singleDollarTextMath }]],
           },
           vite: {
             plugins: [vitePluginStarlightObsidianConfig(config)],

package/libs/markdown.ts

@@ -7,19 +7,14 @@ import { VFile } from 'vfile'
 
 import { remarkStarlightObsidian, type TransformContext } from './remark'
 
-const processor = remark()
-  .data('settings', { resourceLink: true })
-  .use(remarkGfm)
-  .use(remarkMath)
-  .use(remarkFrontmatter)
-  .use(remarkStarlightObsidian)
+let processor: ReturnType<typeof remark> | undefined
 
 export async function transformMarkdownToString(
   filePath: string,
   markdown: string,
   context: TransformContext,
 ): Promise<TransformResult> {
-  const file = await processor.process(getVFile(filePath, markdown, context))
+  const file = await getProcessor(context).process(getVFile(filePath, markdown, context))
 
   return {
     aliases: file.data.aliases,
@@ -35,6 +30,17 @@ export async function transformMarkdownToAST(filePath: string, markdown: string,
   return fromMarkdown(content)
 }
 
+function getProcessor(context: TransformContext): ReturnType<typeof remark> {
+  processor ??= remark()
+    .data('settings', { resourceLink: true })
+    .use(remarkGfm)
+    .use(remarkMath, { singleDollarTextMath: context.singleDollarTextMath })
+    .use(remarkFrontmatter)
+    .use(remarkStarlightObsidian)
+
+  return processor
+}
+
 function getVFile(filePath: string, markdown: string, context: TransformContext) {
   return new VFile({
     data: { ...context },

package/libs/remark.ts

@@ -50,6 +50,7 @@ const wikilinkReplacementRegex = /!?\[\[(?<url>(?:(?![[\]|]).)+)(?:\|(?<maybeTex
 const tagReplacementRegex = /(?:^|\s)#(?<tag>[\w/-]+)/g
 const calloutRegex = /^\[!(?<type>\w+)][+-]? ?(?<title>.*)$/
 const imageSizeRegex = /^(?:(?<altText>.*)\|)?(?:(?<widthOnly>\d+)|(?:(?<width>\d+)x(?<height>\d+)))$/
+const mdxNonClosingVoidElementRegex = /<(?<tag>br|hr)(?<attrs>[^/>]*)>/g
 
 const asideDelimiter = ':::'
 
@@ -88,6 +89,10 @@ export function remarkStarlightObsidian() {
 
     handleFrontmatter(tree, file, obsidianFrontmatter)
     handleImports(tree, file)
+
+    if (file.data.isMdx) {
+      closeVoidElements(tree)
+    }
   }
 }
 
@@ -750,6 +755,19 @@ function createMdxNode(value: string): Html {
   return { type: 'html', value }
 }
 
+// We are not using `remark-mdx` due to the fact that it makes the parsing step way more strict. During our inital
+// testing round, we found out that a few users had pretty poorly formatted Markdown files (usually the result of
+// various Obisidian migration tools) and we wanted to make sure that they could still use Starlight Obsidian.
+// In MDX files, if the source content contains non-closing void elements, we need to convert them to self-closing
+// ones, e.g. `<br>` to `<br/>`.
+// At the moment, we only support `br` and `hr` elements, but based on feedback, we can eventually support all of them.
+function closeVoidElements(tree: Root) {
+  visit(tree, 'html', (node) => {
+    node.value = node.value.replaceAll(mdxNonClosingVoidElementRegex, '<$<tag>$<attrs>/>')
+    return SKIP
+  })
+}
+
 function ensureTransformContext(file: VFile): asserts file is VFile & { data: TransformContext; dirname: string } {
   if (!file.dirname || !file.data.files || file.data.output === undefined || !file.data.vault) {
     throw new Error('Invalid transform context.')
@@ -767,6 +785,7 @@ export interface TransformContext {
   includeYoutubeComponent?: boolean
   isMdx?: true
   output: StarlightObsidianConfig['output']
+  singleDollarTextMath: StarlightObsidianConfig['math']['singleDollarTextMath']
   skip?: true
   vault: Vault
 }

package/libs/starlight.ts

@@ -185,6 +185,7 @@ async function addContent(
       files: vaultFiles,
       copyFrontmatter: config.copyFrontmatter,
       output: config.output,
+      singleDollarTextMath: config.math.singleDollarTextMath,
       vault,
     })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-obsidian",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "license": "MIT",
   "description": "Starlight plugin to publish Obsidian vaults.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",