From a9082b59e93853339848d99b5dd88de73c1ce5e7 Mon Sep 17 00:00:00 2001
From: Lisandra-dev <mara-li@outlook.fr>
Date: Tue, 27 Feb 2024 20:23:25 +0000
Subject: [PATCH] =?UTF-8?q?=F0=9F=94=84=20synced=20local=20'README.md'=20w?=
 =?UTF-8?q?ith=20remote=20'content/wikis/Quartz.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 43 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 27d6dbdb0fef7..e4260c2f24734 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,49 @@
-# Quartz v4
+---
+title: Quartz
+---
 
-> “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
+-> [PRESET](https://github.com/ObsidianPublisher/plugin-presets):
 
-Quartz is a set of tools that helps you publish your [digital garden](https://jzhao.xyz/posts/networked-thought) and notes as a website for free.
-Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use.
+- [YAML based](https://github.com/ObsidianPublisher/plugin-presets/blob/main/presets/quartz-yaml-based.json)
+- [Obsidian path based](https://github.com/ObsidianPublisher/plugin-presets/blob/main/presets/quartz-yaml-based.json)
 
-🔗 Read the documentation and get started: https://quartz.jzhao.xyz/
+## [Quartz](https://quartz.jzhao.xyz/)
 
-[Join the Discord Community](https://discord.gg/cRFFHYye7t)
+See the official documentation on how to configure Quartz.
 
-## Sponsors
+For the template, a special template that add a "little" more features is available [here](https://github.com/ObsidianPublisher/Publisher-Quartz).
 
-<p align="center">
-  <a href="https://github.com/sponsors/jackyzha0">
-    <img src="https://cdn.jsdelivr.net/gh/jackyzha0/jackyzha0/sponsorkit/sponsors.svg" />
-  </a>
-</p>
+The template includes:
+
+- File and folder icons
+- Mobile navigation
+
+> [!tip] You can click on "Sync fork" to get the latest updates from the original repository.
+
+### File & Folder icons configuration
+
+- Use [Iconize Assistant](https://github.com/Lisandra-dev/iconize-assistant) to save icon path into the frontmatter of the file.
+  > [!note] Iconize icons needs to be accessible by the plugin! I store them into `_assets/PLUGINS/icons`.
+- Configure the plugin to send icons file (using override attachment) into `quartz/static/icons : Replace path of attachment for svg files: `/(_assets\/_PLUGINS\/icons)\/(.*)\/(.*)\.(svg)$/`->`quartz/static/icons/$2/{{name}}`
+- In the file [quartz.layout.ts], add this:
+  ```ts
+  const iconsOptions: IconFolderOptions = {
+    rootIconFolder: "quartz/static/icons",
+    default: {
+      file: "file",
+    },
+  }
+  ```
+  > [!warning] Don't forget to add the default icon (named `file.svg`) in the `quartz/static/icons` folder.
+- Edit `Component.ExlorerBurger()` as follow:
+  ```
+  Component.ExplorerBurger({
+  	//keep your old settings; add only iconSettings
+  	iconSettings: iconsOptions,
+  }),
+  ```
+- Edit `Component.ArticleTitle()` as follow: `Component.ArticleTitle(iconsOptions)`
+
+### Mobile navigation
+
+The mobile navigation is instable and rely on a specific layout. Don't change the layout, order, or place of the components.