upgrade docusaurus to v3.5 (#73)

* upgrade docusaurus to v3.5 Signed-off-by: Aolin <[email protected]> * fix truncate Signed-off-by: Aolin <[email protected]> * update feedOptions Signed-off-by: Aolin <[email protected]> --------- Signed-off-by: Aolin <[email protected]>
Oreoxmt · Sep 8, 2024 · 240198d · 240198d
1 parent 65bb653
commit 240198d
Show file tree

Hide file tree

Showing 35 changed files with 1,796 additions and 2,872 deletions.
diff --git a/website/blog/2021-09-01-deploy-hexo-with-github-actions-1.md b/website/blog/2021-09-01-deploy-hexo-with-github-actions-1.md
@@ -11,7 +11,7 @@ Oreo 同学最近开始记笔记和写心情了，但是就是不走寻常路偏
 
 成，好歹咱也是做过 CI 的，GitHub Actions 也出来一段时间了看起来反响不错，那肯定也可以用 Actions 完成从博客源码到 Pages 部署的完整流程。Google 一搜发现已经有很多很多人做了类似的事情了，但是总有一些小地方不够好看或者是不满足需求，那就只能自己重新造一遍轮子了。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Hexo 的网页渲染逻辑
 

diff --git a/website/blog/2022-03-03-file-download-process/file-download-process.md b/website/blog/2022-03-03-file-download-process/file-download-process.md
@@ -13,7 +13,7 @@ tags: [Tips & Tricks]
 
 代码获取：[github](https://github.com/Oreoxmt/Start-with-Me/tree/master/file-process)
 
-<!--truncate-->
+<!-- truncate -->
 
 # 一键下载
 

diff --git a/...-share-mouse-and-keyboard-with-barrier/share-mouse-and-keyboard-with-barrier.md b/...-share-mouse-and-keyboard-with-barrier/share-mouse-and-keyboard-with-barrier.md
@@ -9,7 +9,7 @@ tags: [Tips & Tricks]
 
 如果你需要同时使用多个终端，又不希望两个键盘、两个鼠标来回切换，或者说你只有一个键盘、一个鼠标却想要控制多个终端的话，那这个超级低成本的小技巧就非常适合你啦！
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 场景介绍
 

diff --git a/website/blog/2022-07-31-reading-list.md b/website/blog/2022-07-31-reading-list.md
@@ -7,7 +7,7 @@ tags: [Reading List, Git, Tips & Tricks]
 
 My Reading List from July 16, 2022, to July 31, 2022.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Lists
 
@@ -18,7 +18,7 @@ My Reading List from July 16, 2022, to July 31, 2022.
 | [Shell productivity tips and tricks](#shell-tips) | _We will cover some shell features you can leverage to make your shell do more of the work for you._| [Tips & Tricks](/blog/tags/tips-tricks) |
 | [6 deprecated Linux commands and the tools you should be using instead](#deprecated-linux-commands) | _Swap your old Linux commands for new and improved alternatives that provide the same functionality, if not more._ | [Tips & Tricks](/blog/tags/tips-tricks) |
 
-<!--truncate-->
+<!-- truncate -->
 
 ## [Things I wish everyone knew about Git (Part I)](https://blog.plover.com/prog/git/tips.html) {#git-part-1}
 

diff --git a/website/blog/2022-08-07-bundle-scripts-using-webpack.md b/website/blog/2022-08-07-bundle-scripts-using-webpack.md
@@ -18,7 +18,7 @@ I use [webpack](https://webpack.js.org) to bundle some JS scripts today, see [op
 - To use [JS scripts](https://github.com/Oreoxmt/openapi-scripts/tree/main/src), I build a Docker image [`ghcr.io/oreoxmt/openapi-scripts`](https://github.com/Oreoxmt/openapi-scripts/pkgs/container/openapi-scripts).
 - The Docker image is under rapid development, and it takes a long time to pull the latest image due to 3901 node modules.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1. Install `webpack-cli`
 

diff --git a/website/blog/2022-08-07-deploy-openapi-using-netlify.md b/website/blog/2022-08-07-deploy-openapi-using-netlify.md
@@ -13,7 +13,7 @@ tags: [GitHub API, OpenAPI, Netlify, Tips & Tricks, How-tos]
     - build the `open-api-swagger.json` specification file into an HTML file `index.html` using [`redoc-cli build`](https://redocly.com/docs/redoc/deployment/cli/#redoc-cli-commands)
     - deploy it on Netlify or other services
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1. Import my repository to Netlify
 

diff --git a/website/blog/2022-11-27-manage-python-project-using-poetry.md b/website/blog/2022-11-27-manage-python-project-using-poetry.md
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
 
 前段时间在写 [tidbcloudy](https://github.com/Oreoxmt/tidbcloudy)（一个 TiDB Cloud Python SDK）的时候用到了 [Poetry](https://python-poetry.org) 来管理依赖以及发布到 PyPI。经历了五次小版本的迭代，感觉 Poetry 时常让我有一种“写 SDK 也不难，发版也可以很简单”的错觉，所以决定记录一下我是如何使用 Poetry 来完成我的第一个 SDK 的。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Poetry 是什么
 

diff --git a/website/blog/2023-02-12-crawl-website-using-github-actions.md b/website/blog/2023-02-12-crawl-website-using-github-actions.md
@@ -7,7 +7,7 @@ tags: [Algolia, Docusaurus, GitHub Actions, Tips & Tricks, How-tos]
 
 This document introduces how to configure [Algolia DocSearch](https://docsearch.algolia.com) for your [Docusaurus](https://docusaurus.io/docs) website and crawl your website automatically using GitHub Actions.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1: Apply for Algolia DocSearch
 

diff --git a/.../blog/2023-02-19-first-impressions-of-bytebase/first-impressions-of-bytebase.md b/.../blog/2023-02-19-first-impressions-of-bytebase/first-impressions-of-bytebase.md
@@ -24,7 +24,7 @@ Recently, I have been working on migrating a project's database from SQLite to T
 3. [Query data](#query-data) and [modify schema](#modify-schema) using the sample data
 4. [Integrate Bytebase with TiDB Cloud](#integrate-bytebase-with-tidb-cloud)
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Install Bytebase on macOS
 

diff --git a/website/blog/2023-02-26-code-driven-documentation.md b/website/blog/2023-02-26-code-driven-documentation.md
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
 
 This document outlines how to utilize code to enhance the accuracy of configuration documentation, particularly for technical writers who might not be well-versed in coding but are responsible for creating or reviewing configuration files. By following the examples in this document, writers can ensure that their configuration files are correct, efficient, and easy to understand, while also reducing the risk of errors or inconsistencies.
 
-<!--truncate-->
+<!-- truncate -->
 
 [Documentation-driven development](https://johnsamuel.info/en/programming/documentation-driven-development.html) emphasizes the importance of creating documentation that meets the needs of users. Code-driven documentation here prioritizes the accuracy and consistency of documentation by relying on the source of truth, which is the **code** itself. By using code to verify documentation, technical writers can ensure that their documentation is up-to-date and correctly reflects the behavior of the system, which can help to reduce errors and improve the overall quality of the documentation.
 

diff --git a/website/blog/2023-03-04-identify-git-outdated-files.md b/website/blog/2023-03-04-identify-git-outdated-files.md
@@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
 
 为了及时发现文档仓库中可能过时的内容，你可以使用 [`git log`](https://git-scm.com/docs/git-log) 命令获取文档的最后一次更新信息，以发现长期未更新的文档。下面具体介绍如何使用 `git log` 生成指定目录下所有 Markdown 文件的最后一次 commit 信息。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 使用方法
 

diff --git a/website/blog/2023-03-11-time-in-python.md b/website/blog/2023-03-11-time-in-python.md
@@ -19,7 +19,7 @@ while True:
         break
 ```
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Python 中获取当前时间的函数
 

diff --git a/website/blog/2023-03-19-cpp-beginner-guess-number.md b/website/blog/2023-03-19-cpp-beginner-guess-number.md
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 
 这篇博客记录了我跟着 [C++ Beginner's Guide](https://hackingcpp.com/cpp/beginners_guide.html) 学习 C++ 的第一天，并通过一个猜数字游戏的实践来加深对 I/O、基本数据类型、控制流等基础知识的理解。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 准备开发环境
 

diff --git a/website/blog/2023-08-23-python-test-shell-scripts.md b/website/blog/2023-08-23-python-test-shell-scripts.md
@@ -13,7 +13,7 @@ tags: [Python, Test, Shell]
 
 下面以测试 `sync_scaffold.sh` 为例，该脚本用于更新 `markdown-pages` 目录以及 `docs.json` 文件内容。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 问题拆解
 

diff --git a/website/blog/2023-09-04-cpp-beginner-cmake.md b/website/blog/2023-09-04-cpp-beginner-cmake.md
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
 
 本文介绍如何利用 CMake 来管理一个 C++ 学习项目，帮助你快速实现编译和运行。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 什么是 CMake？
 

diff --git a/website/blog/2024-01-12-cpp-beginner-stringtoint-stringstream.md b/website/blog/2024-01-12-cpp-beginner-stringtoint-stringstream.md
@@ -20,7 +20,7 @@ The basic unit of communication between a program and its environment is a _stre
 
 :::
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Overview of string stream
 

diff --git a/.../2024-01-29-implement-website-feedback/2024-01-29-implement-website-feedback.md b/.../2024-01-29-implement-website-feedback/2024-01-29-implement-website-feedback.md
@@ -18,7 +18,7 @@ View the demo code: [`writerside-feedback-example`](https://github.com/Oreoxmt/w
 
 Try the feedback widget: [Feedback example page](https://writerside-feedback-example.pages.dev/add-math-formulas.html)
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Prerequisites
 

diff --git a/...ctivity-tools-with-marimo/2024-07-10-building-productivity-tools-with-marimo.md b/...ctivity-tools-with-marimo/2024-07-10-building-productivity-tools-with-marimo.md
@@ -20,7 +20,7 @@ marimo is an open-source reactive notebook for Python — reproducible, git-frie
 
 :::
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Showcasing the tools
 

diff --git a/website/docs/how-tos/code-driven-documentation.md b/website/docs/how-tos/code-driven-documentation.md
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
 
 This document outlines how to utilize code to enhance the accuracy of configuration documentation, particularly for technical writers who might not be well-versed in coding but are responsible for creating or reviewing configuration files. By following the examples in this document, writers can ensure that their configuration files are correct, efficient, and easy to understand, while also reducing the risk of errors or inconsistencies.
 
-<!--truncate-->
+<!-- truncate -->
 
 [Documentation-driven development](https://johnsamuel.info/en/programming/documentation-driven-development.html) emphasizes the importance of creating documentation that meets the needs of users. Code-driven documentation here prioritizes the accuracy and consistency of documentation by relying on the source of truth, which is the **code** itself. By using code to verify documentation, technical writers can ensure that their documentation is up-to-date and correctly reflects the behavior of the system, which can help to reduce errors and improve the overall quality of the documentation.
 

diff --git a/website/docs/how-tos/crawl-website-using-github-actions.md b/website/docs/how-tos/crawl-website-using-github-actions.md
@@ -6,7 +6,7 @@ description: "Introduce how to configure Algolia DocSearch for your Docusaurus w
 
 This document introduces how to configure [Algolia DocSearch](https://docsearch.algolia.com) for your [Docusaurus](https://docusaurus.io/docs) website and crawl your website automatically using GitHub Actions.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1: Apply for Algolia DocSearch
 

diff --git a/website/docs/how-tos/deploy-openapi-using-netlify.md b/website/docs/how-tos/deploy-openapi-using-netlify.md
@@ -11,7 +11,7 @@ description: "Introduce how to deploy an OpenAPI documentation using GitHub API
     - build the `open-api-swagger.json` specification file into an HTML file `index.html` using [`redoc-cli build`](https://redocly.com/docs/redoc/deployment/cli/#redoc-cli-commands)
     - deploy it on Netlify or other services
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1. Import my repository to Netlify
 

diff --git a/website/docs/how-tos/identify-git-outdated-files.md b/website/docs/how-tos/identify-git-outdated-files.md
@@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem';
 
 为了及时发现文档仓库中可能过时的内容，你可以使用 [`git log`](https://git-scm.com/docs/git-log) 命令获取文档的最后一次更新信息，以发现长期未更新的文档。下面具体介绍如何使用 `git log` 生成指定目录下所有 Markdown 文件的最后一次 commit 信息。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## 使用方法
 

diff --git a/website/docs/how-tos/manage-python-project-using-poetry.md b/website/docs/how-tos/manage-python-project-using-poetry.md
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
 
 前段时间在写 [tidbcloudy](https://github.com/Oreoxmt/tidbcloudy)（一个 TiDB Cloud Python SDK）的时候用到了 [Poetry](https://python-poetry.org) 来管理依赖以及发布到 PyPI。经历了五次小版本的迭代，感觉 Poetry 时常让我有一种“写 SDK 也不难，发版也可以很简单”的错觉，所以决定记录一下我是如何使用 Poetry 来完成我的第一个 SDK 的。
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Poetry 是什么
 

diff --git a/website/docs/python/time-in-python.md b/website/docs/python/time-in-python.md
@@ -18,7 +18,7 @@ while True:
         break
 ```
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Python 中获取当前时间的函数
 

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -75,6 +75,7 @@ export default {
           blogSidebarCount: 'ALL',
           showReadingTime: true,
           feedOptions: {
+            xslt: true,
             type: 'all',
             copyright: `Copyright © ${new Date().getFullYear()} Oreo. Built with Docusaurus.`,
             createFeedItems: async (params) => {

diff --git a/website/i18n/en/docusaurus-plugin-content-blog/2022-07-31-reading-list.md b/website/i18n/en/docusaurus-plugin-content-blog/2022-07-31-reading-list.md
@@ -16,7 +16,7 @@ My Reading List from July 16, 2022, to July 31, 2022.
 |                          [Shell productivity tips and tricks](#shell-tips)                          |        _We will cover some shell features you can leverage to make your shell do more of the work for you._        | [Tips & Tricks](/blog/tags/tips-tricks) |
 | [6 deprecated Linux commands and the tools you should be using instead](#deprecated-linux-commands) | _Swap your old Linux commands for new and improved alternatives that provide the same functionality, if not more._ | [Tips & Tricks](/blog/tags/tips-tricks) |
 
-<!--truncate-->
+<!-- truncate -->
 
 ## [Things I wish everyone knew about Git (Part I)](https://blog.plover.com/prog/git/tips.html) {#git-part-1}
 

diff --git a/...8n/en/docusaurus-plugin-content-blog/2022-08-07-deploy-openapi-using-netlify.md b/...8n/en/docusaurus-plugin-content-blog/2022-08-07-deploy-openapi-using-netlify.md
@@ -13,7 +13,7 @@ tags: [GitHub API, OpenAPI, Netlify, Tips & Tricks, How-tos]
     - build the `open-api-swagger.json` specification file into an HTML file `index.html` using [`redoc-cli build`](https://redocly.com/docs/redoc/deployment/cli/#redoc-cli-commands)
     - deploy it on Netlify or other services
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1. Import my repository to Netlify
 

diff --git a/...docusaurus-plugin-content-blog/2023-02-12-crawl-website-using-github-actions.md b/...docusaurus-plugin-content-blog/2023-02-12-crawl-website-using-github-actions.md
@@ -7,7 +7,7 @@ tags: [Algolia, Docusaurus, GitHub Actions, Tips & Tricks, How-tos]
 
 This document introduces how to configure [Algolia DocSearch](https://docsearch.algolia.com) for your [Docusaurus](https://docusaurus.io/docs) website and crawl your website automatically using GitHub Actions.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1: Apply for Algolia DocSearch
 

diff --git a/...-blog/2023-02-19-first-impressions-of-bytebase/first-impressions-of-bytebase.md b/...-blog/2023-02-19-first-impressions-of-bytebase/first-impressions-of-bytebase.md
@@ -24,7 +24,7 @@ Recently, I have been working on migrating a project's database from SQLite to T
 3. [Query data](#query-data) and [modify schema](#modify-schema) using the sample data
 4. [Integrate Bytebase with TiDB Cloud](#integrate-bytebase-with-tidb-cloud)
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Install Bytebase on macOS
 

diff --git a/.../i18n/en/docusaurus-plugin-content-blog/2023-02-26-code-driven-documentation.md b/.../i18n/en/docusaurus-plugin-content-blog/2023-02-26-code-driven-documentation.md
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
 
 This document outlines how to utilize code to enhance the accuracy of configuration documentation, particularly for technical writers who might not be well-versed in coding but are responsible for creating or reviewing configuration files. By following the examples in this document, writers can ensure that their configuration files are correct, efficient, and easy to understand, while also reducing the risk of errors or inconsistencies.
 
-<!--truncate-->
+<!-- truncate -->
 
 [Documentation-driven development](https://johnsamuel.info/en/programming/documentation-driven-development.html) emphasizes the importance of creating documentation that meets the needs of users. Code-driven documentation here prioritizes the accuracy and consistency of documentation by relying on the source of truth, which is the **code** itself. By using code to verify documentation, technical writers can ensure that their documentation is up-to-date and correctly reflects the behavior of the system, which can help to reduce errors and improve the overall quality of the documentation.
 

diff --git a/...18n/en/docusaurus-plugin-content-blog/2023-03-04-identify-git-outdated-files.md b/...18n/en/docusaurus-plugin-content-blog/2023-03-04-identify-git-outdated-files.md
@@ -16,7 +16,7 @@ When maintaining a Git repository, particularly one for documentation, it is com
 
 To identify potential outdated files, you can use the `git log` command to retrieve the last commit log of each file and find long-term inactive files. The following sections describe how to generate a last commit report for a repository and how to write the script step by step.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Usage
 

diff --git a/...aurus-plugin-content-docs/current/how-tos/crawl-website-using-github-actions.md b/...aurus-plugin-content-docs/current/how-tos/crawl-website-using-github-actions.md
@@ -6,7 +6,7 @@ description: "Introduce how to configure Algolia DocSearch for your Docusaurus w
 
 This document introduces how to configure [Algolia DocSearch](https://docsearch.algolia.com) for your [Docusaurus](https://docusaurus.io/docs) website and crawl your website automatically using GitHub Actions.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1: Apply for Algolia DocSearch
 

diff --git a/.../docusaurus-plugin-content-docs/current/how-tos/deploy-openapi-using-netlify.md b/.../docusaurus-plugin-content-docs/current/how-tos/deploy-openapi-using-netlify.md
@@ -11,7 +11,7 @@ description: "Introduce how to deploy an OpenAPI documentation using GitHub API
     - build the `open-api-swagger.json` specification file into an HTML file `index.html` using [`redoc-cli build`](https://redocly.com/docs/redoc/deployment/cli/#redoc-cli-commands)
     - deploy it on Netlify or other services
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Step 1. Import my repository to Netlify
 

diff --git a/...n/docusaurus-plugin-content-docs/current/how-tos/identify-git-outdated-files.md b/...n/docusaurus-plugin-content-docs/current/how-tos/identify-git-outdated-files.md
@@ -15,7 +15,7 @@ When maintaining a Git repository, particularly one for documentation, it is com
 
 To identify potential outdated files, you can use the `git log` command to retrieve the last commit log of each file and find long-term inactive files. The following sections describe how to generate a last commit report for a repository and how to write the script step by step.
 
-<!--truncate-->
+<!-- truncate -->
 
 ## Usage