Type
Status
Date
Tags
Slug
Summary
Category
Password
✍️ Related to MyNotes
Icon
这是一篇记录给自己的数字花园添加Giscus评论系统的文章。
📝 前言
对于自己的数字花园,一开始并没有在评论区和自己的阅读者进行交流互动的打算,主要的原因是考虑到在数字花园中的想法并不成熟,加之数字花园现有的笔记基本是自己学习过程中的笔记,更多的是对自己所学知识的整理。直到昨天在完善自己博客的评论系统,突然想到一个评论系统更能拉近自己和读者之间的交流。面对同样的知识,读者可能会遇到各种各样的问题,希望能与作者进行交流,答疑。所以,决定也给自己数字花园加上一个评论系统。
📝 评论系统的选择
在之前写的《利用Obsidian搭建自己的Digital Garden》中已经详细阐述了自己数字花园搭建的流程。数字花园的实现过程是采用了oleeskild开源的插件obsidian-digital-garden。关于评论系统在它的官方文档中,推荐了3种方案,分别是giscus、utterances和disqus。前两种评论都依赖于github账号,考虑到目前数字花园的笔记主要是后端开发和人工智能,受众是程序员,基本上都有github账号,所以选择了giscus进行配置和部署。
📝 giscus的部署
giscus是基于Github Discussions实现的评论系统,受utterances的启发。它会使用Github Discussions搜索API来搜索当前页面对应的discussions,即对于当前页面的评论。
- 点击以下链接在github创建新仓库
- 在新建的仓库的
settings->general->Discussions
,中打开Discussions功能。
- 点击该链接:https://github.com/apps/giscus,在github安装giscus插件。
- 点击该链接:https://giscus.app/zh-CN,对giscus进行配置,把giscus关联到步骤1创建的新仓库
- 复制以下代码,等待后续步骤的使用。
- 配置数字花园仓库,这里我推荐用GitHub Desktop拉取数字花园仓库,再用vscode编辑,然后再用GitHub Desktop提交并推送到远程仓库的方式。
在
src/site/_includes/components/user
目录下,我们可以给自己的数字花园添加自定义的组件。由于我们是给我们的每篇笔记页面都添加一个评论,所以在该目录下新建notes/footer
目录,在该目录下添加如下文件001-giscus-comment.njk
,文件名除了扩展名.njk
外,名字可以随意。文件内容为步骤5中的内容。- 修改页面布局。编辑
src/_includes/layouts/note.njk
文件。 默认的布局是如图所示,分为左、中、右:
如果不修改,它会在最底层生成一个横跨左、中、右的一个评论区域,影响美观。而我只是想在中间的底部,加上一个评论区域。在
note.njk
文件的<main>...</main>
之间添加如下代码:注释掉main之后,body内相同的代码:
现在的布局如图所示:
- 最终的效果如图所示:
最后,欢迎您到我的数字花园逛逛,一起进步成长,学有所成。
🤗 总结归纳
本文简单讲述了如何为自己的数字花园添加giscus评论系统。
📎 引用或提到的资源
- Mr.Charley. 利用Obsidian搭建自己的Digital Garden. https://blog.rahc.top/article/tech-share-mydigitalgarden.
- oleeskild. obsidian-digital-garden. https://github.com/oleeskild/obsidian-digital-garden.
- giscus. https://giscus.app/zh-CN.
- utterances. https://utteranc.es/.
- disqus. https://disqus.com/.
- GitHub Desktop. https://desktop.github.com/.
- vscode. https://code.visualstudio.com/.
有关在数字花园中部署giscus上的问题,欢迎您在底部评论区留言,一起交流~
- Author:Mr.Charley
- URL:https://blog.rahc.top/article/tech-share-garden-giscus-comment
- Copyright:All articles in this blog, except for special statements, adopt BY-NC-SA agreement. Please indicate the source!
Relate Posts