The Trans Directory
feat(comments): conditional display via frontmatter (#1566)
authored by
David Fischer
and committed by
GitHub
31e0b7c6
a6b2967d
+20
-1
+11
docs/features/comments.md
+11
docs/features/comments.md
···
114
114
}),
115
115
],
116
116
```
117
+
118
+
#### Conditionally display comments
119
+
120
+
Quartz can conditionally display the comment box based on a field `comments` in the frontmatter. By default, all pages will display comments, to disable it for a specific page, set `comments` to `false`.
121
+
122
+
```
123
+
---
124
+
title: Comments disabled here!
125
+
comments: false
126
+
---
127
+
```
+8
-1
quartz/components/Comments.tsx
+8
-1
quartz/components/Comments.tsx
···
25
25
}
26
26
27
27
export default ((opts: Options) => {
28
-
const Comments: QuartzComponent = ({ displayClass, cfg }: QuartzComponentProps) => {
28
+
const Comments: QuartzComponent = ({ displayClass, fileData, cfg }: QuartzComponentProps) => {
29
+
// check if comments should be displayed according to frontmatter
30
+
const commentsFlag: boolean =
31
+
fileData.frontmatter?.comments === true || fileData.frontmatter?.comments === "true"
32
+
if (!commentsFlag) {
33
+
return <></>
34
+
}
35
+
29
36
return (
30
37
<div
31
38
class={classNames(displayClass, "giscus")}