notes/quartz/plugins/emitters/aliases.ts

import { FilePath, joinSegments, resolveRelative, simplifySlug } from "../../util/path"
import { QuartzEmitterPlugin } from "../types"
import { write } from "./helpers"
import DepGraph from "../../depgraph"
import { getAliasSlugs } from "../transformers/frontmatter"

export const AliasRedirects: QuartzEmitterPlugin = () => ({
  name: "AliasRedirects",
  async getDependencyGraph(ctx, content, _resources) {
    const graph = new DepGraph<FilePath>()

    const { argv } = ctx
    for (const [_tree, file] of content) {
      for (const slug of getAliasSlugs(file.data.frontmatter?.aliases ?? [], argv, file)) {
        graph.addEdge(file.data.filePath!, joinSegments(argv.output, slug + ".html") as FilePath)
      }
    }

    return graph
  },
  async *emit(ctx, content, _resources) {
    for (const [_tree, file] of content) {
      const ogSlug = simplifySlug(file.data.slug!)

      for (const slug of file.data.aliases ?? []) {
        const redirUrl = resolveRelative(slug, file.data.slug!)
        yield write({
          ctx,
          content: `
            <!DOCTYPE html>
            <html lang="en-us">
            <head>
            <title>${ogSlug}</title>
            <link rel="canonical" href="${redirUrl}">
            <meta name="robots" content="noindex">
            <meta charset="utf-8">
            <meta http-equiv="refresh" content="0; url=${redirUrl}">
            </head>
            </html>
            `,
          slug,
          ext: ".html",
        })
      }
    }
  },
})
fix(aliases): wikilink resolution for aliases (#1681) With markdownLinkResolution: "shortest", aka "+/- how Obsidian does it" and given pages A and nested/B which has an alias Z, if you try to link from A using [[Z]] it wouldn't work and get 404. This is caused by alias slugs (nested/Z in this case, emitted by AliasRedirects) not being present in the `allSlugs` list which is used by the link transformer. The fix is to compute the alias slugs in the frontmatter transformer and add them to `allSlugs` there. Also we store them in file data to avoid recomputing them when emitting alias redirect pages. Fixes #904 Note: given how currently the markdown/html transformers are ordered this doesn't really work. Given pages A and nested/B which has an alias Z, here's the order which currently happens: md-transformers(A) => html-transformers(A) => md-transformers(B) => html-transformers(B) Since the nested/Z slug will get added when md-transformers(B) are run, but the slugs are used by html-transformers(A) when resolving it's links - the link [[Z]] in A will still 404 A fix for this is to split the parser into two stages - first apply the md-transformers to all files, and only then apply html-transformers to all files. I did just that in a different commit, which is needed for this one to work correctly. 2025-02-25 23:28:16 +02:00			`import { FilePath, joinSegments, resolveRelative, simplifySlug } from "../../util/path"`
modern toc tweaks 2023-06-16 19:41:59 -07:00			`import { QuartzEmitterPlugin } from "../types"`
refactor: move emit from callback to helper file function (#704) * Change emit from callback to helpers file function * Update docs, remove commented code, improve type sig 2024-01-18 18:56:14 +00:00			`import { write } from "./helpers"`
feat(experimental): partial rebuilds (#716) 2024-02-09 15:07:32 +00:00			`import DepGraph from "../../depgraph"`
fix(aliases): wikilink resolution for aliases (#1681) With markdownLinkResolution: "shortest", aka "+/- how Obsidian does it" and given pages A and nested/B which has an alias Z, if you try to link from A using [[Z]] it wouldn't work and get 404. This is caused by alias slugs (nested/Z in this case, emitted by AliasRedirects) not being present in the `allSlugs` list which is used by the link transformer. The fix is to compute the alias slugs in the frontmatter transformer and add them to `allSlugs` there. Also we store them in file data to avoid recomputing them when emitting alias redirect pages. Fixes #904 Note: given how currently the markdown/html transformers are ordered this doesn't really work. Given pages A and nested/B which has an alias Z, here's the order which currently happens: md-transformers(A) => html-transformers(A) => md-transformers(B) => html-transformers(B) Since the nested/Z slug will get added when md-transformers(B) are run, but the slugs are used by html-transformers(A) when resolving it's links - the link [[Z]] in A will still 404 A fix for this is to split the parser into two stages - first apply the md-transformers to all files, and only then apply html-transformers to all files. I did just that in a different commit, which is needed for this one to work correctly. 2025-02-25 23:28:16 +02:00			`import { getAliasSlugs } from "../transformers/frontmatter"`
modern toc tweaks 2023-06-16 19:41:59 -07:00
			`export const AliasRedirects: QuartzEmitterPlugin = () => ({`
			`name: "AliasRedirects",`
feat: implement getDependencyGraph for AliasRedirects emitter (#860) 2024-02-16 00:50:48 +00:00			`async getDependencyGraph(ctx, content, _resources) {`
			`const graph = new DepGraph<FilePath>()`

			`const { argv } = ctx`
			`for (const [_tree, file] of content) {`
fix(aliases): wikilink resolution for aliases (#1681) With markdownLinkResolution: "shortest", aka "+/- how Obsidian does it" and given pages A and nested/B which has an alias Z, if you try to link from A using [[Z]] it wouldn't work and get 404. This is caused by alias slugs (nested/Z in this case, emitted by AliasRedirects) not being present in the `allSlugs` list which is used by the link transformer. The fix is to compute the alias slugs in the frontmatter transformer and add them to `allSlugs` there. Also we store them in file data to avoid recomputing them when emitting alias redirect pages. Fixes #904 Note: given how currently the markdown/html transformers are ordered this doesn't really work. Given pages A and nested/B which has an alias Z, here's the order which currently happens: md-transformers(A) => html-transformers(A) => md-transformers(B) => html-transformers(B) Since the nested/Z slug will get added when md-transformers(B) are run, but the slugs are used by html-transformers(A) when resolving it's links - the link [[Z]] in A will still 404 A fix for this is to split the parser into two stages - first apply the md-transformers to all files, and only then apply html-transformers to all files. I did just that in a different commit, which is needed for this one to work correctly. 2025-02-25 23:28:16 +02:00			`for (const slug of getAliasSlugs(file.data.frontmatter?.aliases ?? [], argv, file)) {`
feat: implement getDependencyGraph for AliasRedirects emitter (#860) 2024-02-16 00:50:48 +00:00			`graph.addEdge(file.data.filePath!, joinSegments(argv.output, slug + ".html") as FilePath)`
			`}`
			`}`

			`return graph`
feat(experimental): partial rebuilds (#716) 2024-02-09 15:07:32 +00:00			`},`
feat: make og images an emitter to properly await image generation (#1826) * checkpoint * make emitters async generators * fix * custom font spec * replace spinner, use disk cache for fonts * use readline instead * make og images look nice 2025-03-13 10:27:46 -07:00			`async *emit(ctx, content, _resources) {`
modern toc tweaks 2023-06-16 19:41:59 -07:00			`for (const [_tree, file] of content) {`
base path refactor to better support subpath hosting 2023-08-19 15:52:25 -07:00			`const ogSlug = simplifySlug(file.data.slug!)`
fix: trailing slash aliases (closes #577) 2023-11-11 09:56:30 -08:00
fix(aliases): wikilink resolution for aliases (#1681) With markdownLinkResolution: "shortest", aka "+/- how Obsidian does it" and given pages A and nested/B which has an alias Z, if you try to link from A using [[Z]] it wouldn't work and get 404. This is caused by alias slugs (nested/Z in this case, emitted by AliasRedirects) not being present in the `allSlugs` list which is used by the link transformer. The fix is to compute the alias slugs in the frontmatter transformer and add them to `allSlugs` there. Also we store them in file data to avoid recomputing them when emitting alias redirect pages. Fixes #904 Note: given how currently the markdown/html transformers are ordered this doesn't really work. Given pages A and nested/B which has an alias Z, here's the order which currently happens: md-transformers(A) => html-transformers(A) => md-transformers(B) => html-transformers(B) Since the nested/Z slug will get added when md-transformers(B) are run, but the slugs are used by html-transformers(A) when resolving it's links - the link [[Z]] in A will still 404 A fix for this is to split the parser into two stages - first apply the md-transformers to all files, and only then apply html-transformers to all files. I did just that in a different commit, which is needed for this one to work correctly. 2025-02-25 23:28:16 +02:00			`for (const slug of file.data.aliases ?? []) {`
base path refactor to better support subpath hosting 2023-08-19 15:52:25 -07:00			`const redirUrl = resolveRelative(slug, file.data.slug!)`
feat: make og images an emitter to properly await image generation (#1826) * checkpoint * make emitters async generators * fix * custom font spec * replace spinner, use disk cache for fonts * use readline instead * make og images look nice 2025-03-13 10:27:46 -07:00			`yield write({`
refactor: move emit from callback to helper file function (#704) * Change emit from callback to helpers file function * Update docs, remove commented code, improve type sig 2024-01-18 18:56:14 +00:00			`ctx,`
modern toc tweaks 2023-06-16 19:41:59 -07:00			content: `
			`<!DOCTYPE html>`
			`<html lang="en-us">`
			`<head>`
			`<title>${ogSlug}</title>`
			`<link rel="canonical" href="${redirUrl}">`
			`<meta name="robots" content="noindex">`
			`<meta charset="utf-8">`
			`<meta http-equiv="refresh" content="0; url=${redirUrl}">`
			`</head>`
			`</html>`
			`,
			`slug,`
			`ext: ".html",`
			`})`
			`}`
			`}`
run prettier 2023-07-22 17:27:41 -07:00			`},`
modern toc tweaks 2023-06-16 19:41:59 -07:00			`})`