Merge branch 'main' of github.com:Open-DataFlow/DataFlow-Doc

Author: MOLYHECI

README.md

@@ -1,6 +1,7 @@
 # data-flow-doc
 
-The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
+这个是[https://github.com/Open-DataFlow/DataFlow](https://github.com/Open-DataFlow/DataFlow)的文档。
+
 
 ## Install
 
@@ -11,30 +12,27 @@ npm i
 ## Usage
 
 ```sh
-# start dev server
+# start dev server 一般用这个，可以动态热渲染所有markdown的修改
 npm run docs:dev
-# build for production
+# build for production 这个主要是上传github之前测试下有无bug，有bug的话github无法渲染page的。
 npm run docs:build
-# preview production build in local
-npm run docs:preview
-# update vuepress and theme
-npm run vp-update
 ```
 
-## Deploy to GitHub Pages
-
-The plume theme has been created with GitHub Actions: `.github/workflows/docs-deploy.yml`. You also need to make the following settings in the GitHub repository:
-
-- [ ] `settings > Actions > General`, Scroll to the bottom of the page, under `Workflow permissions`, check `Read and write permissions`, and click the save button.
+## 基本开发结构介绍：
+基本都是一式两份，英语一份，汉语一份。
 
-- [ ] `settings > Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button.
-  (The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.)
+上方的导航栏配置主要在这个文件夹下：[navbars](./docs/.vuepress/navbars/)
+各个文章的侧边栏主要是在这个文件夹下配置[sidebar](./docs/.vuepress/notes/)，可以手动可以自动，参考模板文档的[Sidebar配置](https://theme-plume.vuejs.press/config/theme/#sidebar)
 
-- [ ] Modify the `base` option in `docs/.vuepress/config.ts`:
-  - If you are planning to deploy to `https://<USERNAME>.github.io/`, you can skip this step as `base` defaults to `"/"`.
-  - If you are planning to deploy to `https://<USERNAME>.github.io/<REPO>/`, meaning your repository URL is `https://github.com/<USERNAME>/<REPO>`, set `base` to `"/<REPO>/"`.
-
-To customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
+如果开启了`npm run docs:dev`，在新建markdown的时候，会在markdown头部有一些配置前缀，这里简要介绍下：
+```yaml
+---
+title: 框架设计 # 这个标题会用来作为sidebar的标题
+createTime: 2025/06/13 14:59:56 # 不太重要
+icon: material-symbols:deployed-code-outline # 可选，侧边栏展示时的小logo
+permalink: /zh/guide/framework/ # 这个自动生成的是8位码，可以自行修改以简明展示，注意不能和现有的其他md的路径重复。
+---
+```
 
 ## Documents
 

docs/.vuepress/navbar.ts

@@ -0,0 +1,44 @@
+/**
+ * @see https://theme-plume.vuejs.press/config/navigation/ 查看文档了解配置详情
+ *
+ * Navbar 配置文件，它在 `.vuepress/plume.config.ts` 中被导入。
+ */
+
+import { defineNavbarConfig } from 'vuepress-theme-plume'
+
+export const enNavbar = defineNavbarConfig([
+    // { text: 'Home', link: '/' },
+    // { text: 'Blog', link: '/blog/' },
+    // { text: 'Tags', link: '/blog/tags/' },
+    // { text: 'Archives', link: '/blog/archives/' },
+    {
+        text: 'Guide',
+        // link: '/en/guide/',
+        icon: 'icon-park-outline:guide-board',
+        items: [
+            {
+                text: 'Installation',
+                link: '/en/note/guide/quickstart/install.md',
+                icon: 'material-symbols-light:download-rounded'
+            },
+        ]
+    },
+    {
+        text: 'API Reference',
+        link: '/en/blog/',
+        icon: 'material-symbols:article-outline'
+    },
+    {
+        text: 'Developer Guide',
+        items: [
+            { text: "logging", link: '/en/dev_guide/logging.md' },
+            { text: "testcase", link: '/en/dev_guide/testcase.md' },
+        ]
+    },
+    {
+        text: 'Notes',
+        items: [
+            { text: 'Demo', link: '/en/notes/demo/README.md' }
+        ]
+    },
+])

docs/.vuepress/navbars/en/index.ts

@@ -0,0 +1,2 @@
+export * from './en/index.js'
+export * from './zh/index.js'

docs/.vuepress/navbars/index.ts

@@ -0,0 +1,71 @@
+/**
+ * @see https://theme-plume.vuejs.press/config/navigation/ 查看文档了解配置详情
+ *
+ * Navbar 配置文件，它在 `.vuepress/plume.config.ts` 中被导入。
+ */
+
+import { defineNavbarConfig } from 'vuepress-theme-plume'
+
+export const zhNavbar = defineNavbarConfig([
+    // { text: '首页', link: '/zh/' },
+    // { text: '博客', link: '/zh/blog/' },
+    // { text: '标签', link: '/zh/blog/tags/' },
+    // { text: '归档', link: '/zh/blog/archives/' },
+    {
+        text: '指南',
+        // link: '/zh/guide/',
+        icon: 'icon-park-outline:guide-board',
+        items: [
+            
+            {
+                text: '基本信息',
+                items: [
+                            {
+                                text: '简介',
+                                link: '/zh/notes/guide/basicinfo/intro.md',
+                                icon: 'material-symbols-light:download-rounded',
+                                activeMatch: '^/guide/'
+                            },
+                            {
+                                text: '框架设计',
+                                link: '/zh/notes/guide/basicinfo/framework.md',
+                                icon: 'material-symbols-light:download-rounded',
+                                activeMatch: '^/guide/'
+                            },
+                ]
+            },
+            {
+                text: '快速开始',
+                items: [
+                            {
+                        text: '安装',
+                        link: '/zh/notes/guide/quickstart/install.md',
+                        icon: 'material-symbols-light:download-rounded',
+                        activeMatch: '^/guide/'
+                    },
+                ]
+            },
+
+
+        ]
+    },
+    {
+        text: 'API 文档',
+        link: '/zh/notes/api/1.home.md',
+        icon: 'material-symbols:article-outline'
+    },
+    {
+        text: '开发者指南',
+        // items: [
+        //     { text: "PR规范", link: '/zh/notes/dev_guide/pull_request.md' },
+        //     { text: "日志", link: '/zh/notes/dev_guide/logging.md' },
+        //     { text: "测试用例", link: '/zh/notes/dev_guide/testcase.md' },
+        // ]
+        link: '/zh/notes/dev_guide/1.index_guide.md',
+    },
+    // {
+    //     text: '笔记',
+    //     items: [{ text: '示例', link: '/zh/notes/demo/README.md' }]
+    // },
+])
+

docs/.vuepress/navbars/zh/index.ts

@@ -0,0 +1,68 @@
+import type { ThemeNote } from 'vuepress-theme-plume'
+import { defineNoteConfig } from 'vuepress-theme-plume'
+
+export const Guide: ThemeNote = defineNoteConfig({
+    dir: 'guide',
+    link: '/guide/',
+    sidebar: [
+        {
+            text: 'Quick Start',
+            collapsed: false,
+            icon: 'carbon:idea',
+            prefix: 'quickstart',
+            items: [
+                'install',
+                // 'usage',
+                // 'project-structure',
+                // 'write',
+                // 'blog',
+                // 'document',
+                // 'international',
+                // 'deployment',
+                // 'optimize-build',
+            ],
+        },
+        {
+            text: 'Write',
+            icon: 'fluent-mdl2:edit-create',
+            collapsed: false,
+            items: [
+                {
+                    text: 'markdown',
+                    icon: 'material-symbols:markdown-outline',
+                    prefix: 'markdown',
+                    collapsed: true,
+                    items: [
+                        'basic',
+                        'extensions',
+                        'icons',
+                        'mark',
+                        'plot',
+                        'abbr',
+                        'annotation',
+                        'card',
+                        'steps',
+                        'file-tree',
+                        'tabs',
+                        'timeline',
+                        'demo-wrapper',
+                        'collapse',
+                        'npm-to',
+                        'caniuse',
+                        'include',
+                    ],
+                },
+            ],
+        },
+        {
+            text: 'Customization',
+            icon: 'material-symbols:dashboard-customize-outline-rounded',
+            collapsed: false,
+            prefix: 'custom',
+            items: [
+                'home',
+                'style',
+            ],
+        },
+    ],
+})