From b1dddab1c8a05a53118c40a5daa0129761aed8a5 Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Sun, 20 Aug 2023 00:52:49 -0700 Subject: [PATCH] docs: update notes for tag and folder listings --- content/features/folder and tag listings.md | 4 ++++ content/migrating from Quartz 3.md | 3 +++ quartz/styles/base.scss | 1 - 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/content/features/folder and tag listings.md b/content/features/folder and tag listings.md index caad796b..dfde7c26 100644 --- a/content/features/folder and tag listings.md +++ b/content/features/folder and tag listings.md @@ -14,12 +14,16 @@ Additionally, Quartz will also generate pages for subfolders. Say you have a not By default, Quartz will title the page `Folder: ` and no description. You can override this by creating an `index.md` file in the folder with the `title` [[authoring content#Syntax|frontmatter]] field. Any content you write in this file will also be used in the description of the folder. +For example, for the folder `content/posts`, you can add another file `content/posts/index.md` to add a specific description for it. + ## Tag Listings Quartz will also create an index page for each unique tag in your vault and render a list of all notes with that tag. Quartz also supports tag hierarchies as well (e.g. `plugin/emitter`) and will also render a separate tag page for each layer of the tag hierarchy. It will also create a default global tag index page at `/tags` that displays a list of all the tags in your Quartz. +Like folder listings, you can also provide a description and title for a tag page by creating a file for each tag. For example, if you wanted to create a custom description for the #component tag, you would create a file at `content/tags/component.md` with a title and description. + ## Customization The layout for both the folder and content pages can be customized. By default, they use the `defaultListPageLayout` in `quartz.layouts.ts`. If you'd like to make more involved changes to the layout and don't mind editing some [[creating components|Quartz components]], you can take a look at `quartz/components/pages/FolderContent.tsx` and `quartz/components/pages/TagContent.tsx` respectively. diff --git a/content/migrating from Quartz 3.md b/content/migrating from Quartz 3.md index 22263d9c..2fdc7315 100644 --- a/content/migrating from Quartz 3.md +++ b/content/migrating from Quartz 3.md @@ -34,5 +34,8 @@ When running `npx quartz create`, you will be prompted as to how to initialize y - You will need to update your deploy scripts. See the [[hosting]] guide for more details. - Ensure that your default branch on GitHub is updated from `hugo` to `v4`. +- [[folder and tag listings|Folder and tag listings]] have also changed. + - Folder descriptions should go under `content//index.md` where `` is the name of the folder. + - Tag descriptions should go under `content/tags/.md` where `` is the name of the tag. - Some HTML layout may not be the same between Quartz 3 and Quartz 4. If you depended on a particular HTML hierarchy or class names, you may need to update your custom CSS to reflect these changes. - If you customized the layout of Quartz 3, you may need to translate these changes from Go templates back to JSX as Quartz 4 no longer uses Hugo. For components, check out the guide on [[creating components]] for more details on this. diff --git a/quartz/styles/base.scss b/quartz/styles/base.scss index 1bbefe9c..fad5dc0c 100644 --- a/quartz/styles/base.scss +++ b/quartz/styles/base.scss @@ -45,7 +45,6 @@ ul, } .math { - font-size: 1.1rem; &.math-display { text-align: center; }