feat: automatic readme toc generator

.github/workflows/toc.yml

@@ -0,0 +1,35 @@
+name: TOC Generator
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+      - README_zh.md
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      # - uses: technote-space/toc-generator@v4
+      #   with:
+      #     CREATE_PR: true
+      #     GITHUB_TOKEN: ${{ secrets.LIBRO_TOKEN }}
+      #     PR_TITLE: 'chore(docs): update TOC of readme'
+
+      - name: Generate TOC for README.md
+        uses: technote-space/toc-generator@v4
+        with:
+          TARGET_PATHS: README.md
+          TOC_TITLE: '## Table of Contents'
+          GITHUB_TOKEN: ${{ secrets.LIBRO_TOKEN }}
+          PR_TITLE: 'chore(docs): update TOC of readme'
+
+      - name: Generate TOC for README_zh.md
+        uses: technote-space/toc-generator@v4
+        with:
+          TARGET_PATHS: README_zh.md
+          TOC_TITLE: '## 目录'
+          CREATE_PR: true
+          GITHUB_TOKEN: ${{ secrets.LIBRO_TOKEN }}
+          PR_TITLE: 'chore(docs): update TOC of readme'

README.md

@@ -27,20 +27,8 @@ Language: English | [简体中文](./README_zh.md)
 
 ---
 
-## Table of Contents
-
-- [Quick Start](#Quick-Start)
-- [Quick Integration](#Quick-Integration)
-- [New Features](#New-Features)
-  - [prompt cell](#prompt-cell)
-  - [sql cell](#sql-cell)
-- [Technical Architecture](#Technical-Architecture)
-- [Future Plans](#Future-Plans)
-- [More](#More)
-  - [Reporting Issues](#Reporting-Issues)
-  - [Contributing](#Contributing)
-  - [Contributors](#Contributors)
-  - [Contact Us](#Contact-Us)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ---
 
@@ -58,7 +46,7 @@ For more details, please refer to [quick start](./apps/docs/docs/quickstart/inde
 
 ## Quick Integration
 
-libro is fully modular, giving you the flexibility to choose from its native capability modules or add custom ones for extended development. To learn more about the modular development approach, check out [mana](https://github.com/difizen/mana).
+Libro is fully modular, giving you the flexibility to choose from its native capability modules or add custom ones for extended development. To learn more about the modular development approach, check out [mana](https://github.com/difizen/mana).
 
 You can assemble different modules based on your needs to build your own notebook product. For example, you might integrate only the editor-related modules into an IDE or other development environments, or bring in more modules to create a lab-style solution.
 

README_zh.md

@@ -19,28 +19,16 @@
 
 <p>　</p>
 <p align="center">
-🌟🌟🌟 如果你也喜欢这个项目，欢迎为我们点亮 🌟🌟🌟
+🌟🌟🌟 如果您也喜欢这个项目，欢迎为我们点亮 🌟🌟🌟
 </p>
 <p>　</p>
 
 ![image](./apps/docs/public/libro.png)
 
 ---
 
-## 目录
-
-- [快速开始](#快速开始)
-- [快速集成](#快速集成)
-- [新特性](#新特性)
-  - [prompt cell](#prompt-cell)
-  - [sql cell](#sql-cell)
-- [架构](#架构)
-- [后续计划](#后续计划)
-- [更多](#更多)
-  - [提交issue](#提交issue)
-  - [贡献代码](#贡献代码)
-  - [贡献者](#贡献者)
-  - [联系我们](#联系我们)
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ---