starlight-obsidian 0.9.0 → 0.9.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # starlight-obsidian
 
+## 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/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.')

package/package.json

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