mirror of
				https://github.com/ZetaKebab/quartz.git
				synced 2025-11-03 22:49:47 +00:00 
			
		
		
		
	support attachments folder
This commit is contained in:
		@@ -5,6 +5,8 @@ draft: true
 | 
			
		||||
## high priority
 | 
			
		||||
 | 
			
		||||
- attachments path
 | 
			
		||||
- inspect bundle size generated by esbuild (it shouldnt be that high)
 | 
			
		||||
- component resources should be emitted by an emitter
 | 
			
		||||
- https://help.obsidian.md/Editing+and+formatting/Tags#Nested+tags nested tags??
 | 
			
		||||
- watch mode for config/source code
 | 
			
		||||
- https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Task+lists task list styling
 | 
			
		||||
 
 | 
			
		||||
@@ -114,7 +114,7 @@ const config: QuartzConfig = {
 | 
			
		||||
        enableSiteMap: true,
 | 
			
		||||
        enableRSS: true,
 | 
			
		||||
      }),
 | 
			
		||||
      Plugin.Assets(),
 | 
			
		||||
      Plugin.Assets({ attachmentsFolder: "attachments" }),
 | 
			
		||||
      Plugin.Static(),
 | 
			
		||||
    ],
 | 
			
		||||
  },
 | 
			
		||||
 
 | 
			
		||||
@@ -4,31 +4,52 @@ import { QuartzEmitterPlugin } from "../types"
 | 
			
		||||
import path from "path"
 | 
			
		||||
import fs from "fs"
 | 
			
		||||
 | 
			
		||||
export const Assets: QuartzEmitterPlugin = () => ({
 | 
			
		||||
  name: "Assets",
 | 
			
		||||
  getQuartzComponents() {
 | 
			
		||||
    return []
 | 
			
		||||
  },
 | 
			
		||||
  async emit({ argv }, _content, _resources, _emit): Promise<FilePath[]> {
 | 
			
		||||
    // glob all non MD/MDX/HTML files in content folder and copy it over
 | 
			
		||||
    const assetsPath = path.join(argv.output, "assets")
 | 
			
		||||
interface Options {
 | 
			
		||||
  attachmentsFolder: string | null
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
    const fps: FilePath[] = []
 | 
			
		||||
    for await (const rawFp of globbyStream("**", {
 | 
			
		||||
      ignore: ["**/*.md"],
 | 
			
		||||
      cwd: argv.directory,
 | 
			
		||||
    })) {
 | 
			
		||||
      const fp = rawFp as FilePath
 | 
			
		||||
      const ext = path.extname(fp)
 | 
			
		||||
      const src = path.join(argv.directory, fp) as FilePath
 | 
			
		||||
      const name = (slugifyFilePath(fp as FilePath) + ext) as FilePath
 | 
			
		||||
      const dest = path.join(assetsPath, name) as FilePath
 | 
			
		||||
      const dir = path.dirname(dest) as FilePath
 | 
			
		||||
      await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists
 | 
			
		||||
      await fs.promises.copyFile(src, dest)
 | 
			
		||||
      fps.push(path.join("assets", fp) as FilePath)
 | 
			
		||||
    }
 | 
			
		||||
const defaultOptions: Options = {
 | 
			
		||||
  attachmentsFolder: null,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
    return fps
 | 
			
		||||
  },
 | 
			
		||||
})
 | 
			
		||||
export const Assets: QuartzEmitterPlugin<Options> = (userOpts?: Options) => {
 | 
			
		||||
  const { attachmentsFolder } = { ...defaultOptions, ...userOpts }
 | 
			
		||||
 | 
			
		||||
  return {
 | 
			
		||||
    name: "Assets",
 | 
			
		||||
    getQuartzComponents() {
 | 
			
		||||
      return []
 | 
			
		||||
    },
 | 
			
		||||
    async emit({ argv }, _content, _resources, _emit): Promise<FilePath[]> {
 | 
			
		||||
      // glob all non MD/MDX/HTML files in content folder and copy it over
 | 
			
		||||
      const assetsPath = path.join(argv.output, "assets")
 | 
			
		||||
 | 
			
		||||
      const fps: FilePath[] = []
 | 
			
		||||
      for await (const rawFp of globbyStream("**", {
 | 
			
		||||
        ignore: ["**/*.md"],
 | 
			
		||||
        cwd: argv.directory,
 | 
			
		||||
      })) {
 | 
			
		||||
        const fp = rawFp as FilePath
 | 
			
		||||
        const ext = path.extname(fp)
 | 
			
		||||
        const src = path.join(argv.directory, fp) as FilePath
 | 
			
		||||
        let name = (slugifyFilePath(fp as FilePath) + ext) as FilePath
 | 
			
		||||
 | 
			
		||||
        if (attachmentsFolder) {
 | 
			
		||||
          const segments = name.split("/")
 | 
			
		||||
          if (segments.at(-2) === attachmentsFolder) {
 | 
			
		||||
            segments.splice(-2, 1)
 | 
			
		||||
            name = segments.join("/") as FilePath
 | 
			
		||||
          }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        const dest = path.join(assetsPath, name) as FilePath
 | 
			
		||||
        const dir = path.dirname(dest) as FilePath
 | 
			
		||||
        await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists
 | 
			
		||||
        await fs.promises.copyFile(src, dest)
 | 
			
		||||
        fps.push(path.join("assets", fp) as FilePath)
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      return fps
 | 
			
		||||
    },
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -86,7 +86,6 @@ function addGlobalPageResources(
 | 
			
		||||
 | 
			
		||||
export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) {
 | 
			
		||||
  const { argv, cfg } = ctx
 | 
			
		||||
  const contentFolder = argv.directory
 | 
			
		||||
  const perf = new PerfTimer()
 | 
			
		||||
  const log = new QuartzLogger(ctx.argv.verbose)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user