Wikilinks

Installation

1. Install BrainDB

2. Install remark-wiki-link

   pnpm add @braindb/remark-wiki-link

3. Configure Astro

   astro.config.mjs

   import remarkWikiLink from "@braindb/remark-wiki-link";
   import { bdb } from "./src/lib/braindb.mjs";
   
   await bdb.ready();
   
   export default defineConfig({
     markdown: {
       remarkPlugins: [
         [
           remarkWikiLink,
           {
             linkTemplate: ({ slug, alias }) => {
               const [slugWithoutAnchor, anchor] = slug.split("#");
               const doc = bdb.documentsSync({ slug: slugWithoutAnchor })[0];
               if (doc) {
                 return {
                   hName: "a",
                   hProperties: {
                     href: anchor ? `${doc.url()}#${anchor}` : doc.url(),
                   },
                   hChildren: [
                     {
                       type: "text",
                       value: alias == null ? doc.frontmatter().title : alias,
                     },
                   ],
                 };
               } else {
                 return {
                   hName: "span",
                   hProperties: {
                     class: "broken-link",
                     title: `Can't resolve link to ${slug}`,
                   },
                   hChildren: [{ type: "text", value: alias || slug }],
                 };
               }
             },
           },
         ],
       ],
     },
   });

Example

[[backlinks]] [[404|Example of broken link]]

Backlinks Example of broken link

Further improvements

• support anchors in wikilinks ([[page#anchor]], [[page#anchor|alias]])
  • do we need to url-encode anchors?
  • do we need to slugify anchors?
• check that anchors correspond to some header in target document
• what about ambiguous links (bdb.documentsSync({ slug: permalink }).length > 1)?
• image wikilinks (![[some.jpg]])