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
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import type { FileSystemWriter } from "../filesystem_writer/interface.ts";
import type { FileSystemReader } from "../filesystem_reader/interface.ts";
import type { DocumentTree } from "../types.ts";

export interface BuildParameters {
	readonly documentTree: DocumentTree;
	readonly fileSystemReader: FileSystemReader;
	readonly fileSystemWriter: FileSystemWriter;
}

export interface PageBuilder {
	/**
	 * Builds pages from document tree then write them to the filesystem.
	 */
	build(params: BuildParameters): Promise<void>;
}