Changes
1 changed files (+27/-27)
-
-
@@ -24,19 +24,19 @@ Read the following sections if you're not sure what these lines are doing.```ts // build.ts import { DenoFsReader } from "https://deno.land/x/macana@v0.1.0/filesystem_reader/deno_fs.ts"; import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/deno_fs.ts"; import { DenoFsReader } from "https://deno.land/x/macana@v0.1.1/filesystem_reader/deno_fs.ts"; import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/deno_fs.ts"; import { DefaultTreeBuilder, fileExtensions, ignoreDotfiles, removeExtFromMetadata, defaultDocumentAt, } from "https://deno.land/x/macana@v0.1.0/tree_builder/default_tree_builder.ts"; import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.0/content_parser/obsidian_markdown.ts"; import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.0/content_parser/json_canvas.ts"; import { oneof } from "https://deno.land/x/macana@v0.1.0/content_parser/oneof.ts"; import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.0/page_builder/default_theme/mod.ts"; } from "https://deno.land/x/macana@v0.1.1/tree_builder/default_tree_builder.ts"; import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.1/content_parser/obsidian_markdown.ts"; import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.1/content_parser/json_canvas.ts"; import { oneof } from "https://deno.land/x/macana@v0.1.1/content_parser/oneof.ts"; import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.1/page_builder/default_theme/mod.ts"; const fileSystemReader = new DenoFsReader(new URL("./contents", import.meta.url));
-
@@ -82,19 +82,19 @@ > [!tip]- Sample build script with explanation> If you prefer code instead of paragraphs... > > ```ts > import { DenoFsReader } from "https://deno.land/x/macana@v0.1.0/filesystem_reader/deno_fs.ts"; > import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/deno_fs.ts"; > import { DenoFsReader } from "https://deno.land/x/macana@v0.1.1/filesystem_reader/deno_fs.ts"; > import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/deno_fs.ts"; > import { > DefaultTreeBuilder, > fileExtensions, > ignoreDotfiles, > removeExtFromMetadata, > defaultDocumentAt, > } from "https://deno.land/x/macana@v0.1.0/tree_builder/default_tree_builder.ts"; > import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.0/content_parser/obsidian_markdown.ts"; > import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.0/content_parser/json_canvas.ts"; > import { oneof } from "https://deno.land/x/macana@v0.1.0/content_parser/oneof.ts"; > import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.0/page_builder/default_theme/mod.ts"; > } from "https://deno.land/x/macana@v0.1.1/tree_builder/default_tree_builder.ts"; > import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.1/content_parser/obsidian_markdown.ts"; > import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.1/content_parser/json_canvas.ts"; > import { oneof } from "https://deno.land/x/macana@v0.1.1/content_parser/oneof.ts"; > import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.1/page_builder/default_theme/mod.ts"; > > // Treat `contents/` directory as a Vault. > // By resolving from `import.meta.url`, `contents/` directory next to this
-
@@ -197,7 +197,7 @@ Macana uses abstraction layer for file I/O.FileSystem Reader provides listing directory and reading file contents capability. ```ts import { DenoFsReader } from "https://deno.land/x/macana@v0.1.0/filesystem_reader/deno_fs.ts"; import { DenoFsReader } from "https://deno.land/x/macana@v0.1.1/filesystem_reader/deno_fs.ts"; const fileSystemReader = new DenoFsReader(new URL("./contents", import.meta.url));
-
@@ -222,7 +222,7 @@FileSystem Writer provides capability to write to files and create directories. ```ts import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/deno_fs.ts"; import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/deno_fs.ts"; const fileSystemWriter = new DenoFsWriter(new URL("./.dist", import.meta.url));
-
@@ -250,8 +250,8 @@ `precompress` function adds precompress functionality to the FileSystem Writer.The resulted file formats are compatible with [Caddy](https://caddyserver.com/)'s [`precompressed`](https://caddyserver.com/docs/caddyfile/directives/file_server#syntax) directive. ```ts import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/deno_fs.ts"; import { precompress } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/precompress.ts"; import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/deno_fs.ts"; import { precompress } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/precompress.ts"; const fileSystemWriter = precompress()( new DenoFsWriter(new URL("./.dist", import.meta.url))
-
@@ -275,8 +275,8 @@ `noOverwrite` function skips redundant write to the same file.In addition to that, if it detects the writes to different content to the same file, it aborts the build in order to prevent producing inconsistent build output. ```ts import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/deno_fs.ts"; import { noOverwrite } from "https://deno.land/x/macana@v0.1.0/filesystem_writer/no_overwrite.ts"; import { DenoFsWriter } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/deno_fs.ts"; import { noOverwrite } from "https://deno.land/x/macana@v0.1.1/filesystem_writer/no_overwrite.ts"; const fileSystemWriter = noOverwrite( new DenoFsWriter(new URL("./.dist", import.meta.url))
-
@@ -301,10 +301,10 @@ In order not to constrain too much on what you can do, Macana does very little by default.Uses filename as a title as-is, first found document as a default document, tries to parse every file as a document, etc. ```ts import { DefaultTreeBuilder } from "https://deno.land/x/macana@v0.1.0/tree_builder/default_tree_builder.ts"; import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.0/content_parser/obsidian_markdown.ts"; import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.0/content_parser/json_canvas.ts"; import { oneof } from "https://deno.land/x/macana@v0.1.0/content_parser/oneof.ts"; import { DefaultTreeBuilder } from "https://deno.land/x/macana@v0.1.1/tree_builder/default_tree_builder.ts"; import { ObsidianMarkdownParser } from "https://deno.land/x/macana@v0.1.1/content_parser/obsidian_markdown.ts"; import { JSONCanvasParser } from "https://deno.land/x/macana@v0.1.1/content_parser/json_canvas.ts"; import { oneof } from "https://deno.land/x/macana@v0.1.1/content_parser/oneof.ts"; // This works, but you may (probably) want to tune it further const treeBuilder = new DefaultTreeBuilder({
-
@@ -338,7 +338,7 @@ langDir,// Use file timestamps as creation/update date // (does not work with Git, though) useFileSystemTimestamps, } from "https://deno.land/x/macana@v0.1.0/tree_builder/default_tree_builder.ts"; } from "https://deno.land/x/macana@v0.1.1/tree_builder/default_tree_builder.ts"; const treeBuilder = new DefaultTreeBuilder({ defaultLanguage: "en",
-
@@ -359,7 +359,7 @@ Page Builder builds HTML and other assets from a document tree.If you don't like how Macana's default theme builder works, write your own. ```ts import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.0/page_builder/default_theme/mod.ts"; import { DefaultThemeBuilder } from "https://deno.land/x/macana@v0.1.1/page_builder/default_theme/mod.ts"; const pageBuilder = new DefaultThemeBuilder({ siteName: "<YOUR WEBSITE TITLE>",
-
@@ -397,4 +397,4 @@ "tasks": {"build": "deno run --allow-read=<YOUR VAULT> --allow-write=<OUTPUT DIR> build.ts" } } ``` ```
-