更新博客

shenweiyan · Oct 17, 2023 · f038ae0 · f038ae0
1 parent cf35fdd
commit f038ae0
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 32 deletions.
diff --git a/__pycache__/hooks.cpython-312.pyc b/__pycache__/hooks.cpython-312.pyc
diff --git a/docs/blog/posts/setting-up-a-blog.md b/docs/blog/posts/setting-up-a-blog.md
diff --git a/docs/blog/posts/为-Material-for-MkDocs-增加博客插件.md b/docs/blog/posts/为-Material-for-MkDocs-增加博客插件.md
@@ -0,0 +1,65 @@
+---
+title: 为 Material for MkDocs 增加博客插件
+number: 4
+url: https://github.com/shenweiyan/Knowledge-Garden/discussions/4
+date: 2023-10-16
+createdAt: 2023-10-16T05:11:48Z
+lastEditedAt: 2023-10-17T03:13:28Z
+updatedAt: 2023-10-17T03:13:28Z
+author: [shenweiyan]
+categories: 
+  - 乱弹
+labels: []
+filename: 为-Material-for-MkDocs-增加博客插件.md
+---
+
+Material for MkDocs 从 9.2.0 开始内置博客插件，内置博客插件添加了对从帖子文件夹构建博客的支持，这些帖子带有日期和其他结构化数据注释。
+
+<!-- more -->
+
+Material for MkDocs makes it very easy to build a blog, either as a sidecar to your documentation or standalone. Focus on your content while the engine does all the heavy lifting, automatically generating archive and category indexes, post slugs, configurable pagination and more.
+
+Material for MkDocs 使构建博客变得非常容易，无论是作为文档的附属工具还是独立的博客。专注于您的内容，而引擎会完成所有繁重的工作，自动生成存档和类别索引、帖子段、可配置的分页等等。
+
+存在的一些问题和使用体验：
+
+1. 在 Markdown 中使用 `<!-- more -->` 的写法分割 description 和全文，总感觉有点别扭；
+2. Pagination 分页与 `git-revision-date` 冲突，会引发构建错误 - 参考 [mkdocs-material/discussions/6156](https://github.com/squidfunk/mkdocs-material/discussions/6156)
+
+## 写博客
+
+有感于 Material for MkDocs 的博客结构，现在基本上可以实现使用 Discussions 进行 MkDocs blog 编辑与写作 —— 在 Discussions 上写完文章，借助第三方工具或者 GitHub Actions 导出为 Markdown 文件，保存到 `docs/blog/posts` 就可以啦！
+
+## 加评论
+
+借助 [giscus](https://giscus.app/zh-CN)，可以非常方便在文章页中插入指定的 discussions，及在导出 discussions 的时候，在文章尾部增加类似以下 JavaScript 即可：
+```javascript
+<script src="https://giscus.app/client.js"
+        data-repo="shenweiyan/Knowledge-Garden"
+        data-repo-id="R_kgDOKgxWlg"
+        data-mapping="number"
+        data-term="4"
+        data-reactions-enabled="1"
+        data-emit-metadata="0"
+        data-input-position="bottom"
+        data-theme="light"
+        data-lang="zh-CN"
+        crossorigin="anonymous"
+        async>
+</script>
+```
+
+<script src="https://giscus.app/client.js"
+    data-repo="shenweiyan/Knowledge-Garden"
+    data-repo-id="R_kgDOKgxWlg"
+    data-mapping="number"
+    data-term="4"
+    data-reactions-enabled="1"
+    data-emit-metadata="0"
+    data-input-position="bottom"
+    data-theme="light"
+    data-lang="zh-CN"
+    crossorigin="anonymous"
+    async>
+</script>
+