The Trans Directory
docs: update notes for tag and folder listings
+7
-1
+4
content/features/folder and tag listings.md
+4
content/features/folder and tag listings.md
···
14
14
15
15
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.
16
16
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
+
17
19
## Tag Listings
18
20
19
21
Quartz will also create an index page for each unique tag in your vault and render a list of all notes with that tag.
20
22
21
23
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.
24
+
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.
22
26
23
27
## Customization
24
28
+3
content/migrating from Quartz 3.md
+3
content/migrating from Quartz 3.md
···
34
34
35
35
- You will need to update your deploy scripts. See the [[hosting]] guide for more details.
36
36
- 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.
37
40
- 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.
38
41
- 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.