Skip to content

Commit cfb7d12

Browse files
committed
docs: update notes for tag and folder listings
1 parent 03fd624 commit cfb7d12

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

content/features/folder and tag listings.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,16 @@ Additionally, Quartz will also generate pages for subfolders. Say you have a not
1414

1515
By default, Quartz will title the page `Folder: <name of 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.
1616

17+
For example, for the folder `content/posts`, you can add another file `content/posts/index.md` to add a specific description for it.
18+
1719
## Tag Listings
1820

1921
Quartz will also create an index page for each unique tag in your vault and render a list of all notes with that tag.
2022

2123
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.
2224

25+
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.
26+
2327
## Customization
2428

2529
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.

content/migrating from Quartz 3.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,8 @@ When running `npx quartz create`, you will be prompted as to how to initialize y
3434

3535
- You will need to update your deploy scripts. See the [[hosting]] guide for more details.
3636
- Ensure that your default branch on GitHub is updated from `hugo` to `v4`.
37+
- [[folder and tag listings|Folder and tag listings]] have also changed.
38+
- Folder descriptions should go under `content/<folder-name>/index.md` where `<folder-name>` is the name of the folder.
39+
- Tag descriptions should go under `content/tags/<tag-name>.md` where `<tag-name>` is the name of the tag.
3740
- 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.
3841
- 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.

quartz/styles/base.scss

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ ul,
4545
}
4646

4747
.math {
48-
font-size: 1.1rem;
4948
&.math-display {
5049
text-align: center;
5150
}

0 commit comments

Comments
 (0)