macana

Static site generator for Obsidian Vault

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
  97. 97
  98. 98
  99. 99
  100. 100
  101. 101
  102. 102
  103. 103
  104. 104
  105. 105
  106. 106
  107. 107
  108. 108
  109. 109
  110. 110
  111. 111
  112. 112
  113. 113
  114. 114
  115. 115
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import * as yamlFrontmatter from "../deps/deno.land/std/front_matter/yaml.ts";
import type * as Mdast from "../deps/esm.sh/mdast/types.ts";
import { fromMarkdown } from "../deps/esm.sh/mdast-util-from-markdown/mod.ts";
import { gfmFromMarkdown } from "../deps/esm.sh/mdast-util-gfm/mod.ts";
import { gfm } from "../deps/esm.sh/micromark-extension-gfm/mod.ts";

import { ofmHighlightFromMarkdown } from "./obsidian_markdown/mdast_util_ofm_highlight.ts";
import { ofmHighlight } from "./obsidian_markdown/micromark_extension_ofm_highlight.ts";
import { ofmImageSize } from "./obsidian_markdown/mdast_util_ofm_image_size.ts";

import type {
	ContentParser,
	ContentParseResult,
	ParseParameters,
} from "./interface.ts";
import type { DocumentContent } from "../types.ts";

function getFrontMatterValue(
	frontmatter: Record<string, unknown>,
	key: string,
): string | undefined {
	if (!(key in frontmatter)) {
		return undefined;
	}

	const value = frontmatter[key];
	if (typeof value !== "string") {
		return undefined;
	}

	return value;
}

export type ObsidianMarkdownDocument = DocumentContent<
	"obsidian_markdown",
	Mdast.Nodes
>;

export interface ObsidianMarkdownParserOptions {
	/**
	 * Whether to enable reading of YAML frontmatter.
	 *
	 * ## `title`
	 *
	 * Use property value as a document title.
	 *
	 * ## `name`
	 *
	 * Use property value as a document name.
	 *
	 * ## `lang` / `language`
	 *
	 * Use property value as a document language.
	 *
	 * @default false
	 */
	frontmatter?: boolean;
}

function parseMarkdown(markdown: string | Uint8Array) {
	const mdast = fromMarkdown(markdown, {
		extensions: [gfm(), ofmHighlight()],
		mdastExtensions: [gfmFromMarkdown(), ofmHighlightFromMarkdown()],
	});

	ofmImageSize(mdast);

	return mdast;
}

export class ObsidianMarkdownParser implements ContentParser {
	#frontmatter: boolean;

	constructor({ frontmatter = false }: ObsidianMarkdownParserOptions = {}) {
		this.#frontmatter = frontmatter;
	}

	async parse(
		{ fileReader, documentMetadata }: ParseParameters,
	): Promise<ContentParseResult<ObsidianMarkdownDocument>> {
		const bytes = await fileReader.read();

		if (!this.#frontmatter) {
			return {
				kind: "obsidian_markdown",
				content: parseMarkdown(bytes),
			};
		}

		const frontmatter = yamlFrontmatter.extract(
			new TextDecoder().decode(bytes),
		);

		const name = getFrontMatterValue(frontmatter.attrs, "name");
		const title = getFrontMatterValue(frontmatter.attrs, "title");
		const lang = getFrontMatterValue(frontmatter.attrs, "lang") ||
			getFrontMatterValue(frontmatter.attrs, "language");

		return {
			documentMetadata: {
				name: name || documentMetadata.name,
				title: title || documentMetadata.title,
				language: lang || documentMetadata.language,
			},
			documentContent: {
				kind: "obsidian_markdown",
				content: parseMarkdown(frontmatter.body),
			},
		};
	}
}