From 9060990aa64070e828bebcdb560301d576ea536c Mon Sep 17 00:00:00 2001 From: dralagen Date: Mon, 28 Apr 2025 09:45:49 +0200 Subject: [PATCH] doc(favicon): add documentation of favicon plugin --- docs/plugins/Favicon.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/plugins/Favicon.md diff --git a/docs/plugins/Favicon.md b/docs/plugins/Favicon.md new file mode 100644 index 000000000..a77ae8f23 --- /dev/null +++ b/docs/plugins/Favicon.md @@ -0,0 +1,16 @@ +--- +title: Favicon +tags: + - plugin/emitter +--- + +This plugin emits a `favicon.ico` into the `public` folder. It creates the favicon from `icon.png` located in the `quartz/static` folder. +The plugin resizes `icon.png` to 48x48px to make it as small as possible. + +This plugin has no configuration options. + +## API + +- Category: Emitter +- Function name: `Plugin.Favicon()`. +- Source: [`quartz/plugins/emitters/favicon.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/favicon.ts).