docs: 1. 调整文档代码结构 2. 修复文档内容 3. 修改文档主题

README.md

@@ -1,22 +1,87 @@
+<div align="center">
+
+<a href="http://marsview.cc/"><img src="/.github/imgs/mars-logo.png" width="120" height="120" alt="marsview logo"></a>
+
 # Marsview 低代码平台
 
+让搭建更简单，让开发更高效
+
+[项目文档](http://docs.marsview.cc/) |
+[开源仓库](https://github.com/JackySoft/marsview) |
+[交流群](https://marsview.cdn.bcebos.com/qrcode.jpg)
+
+</div>
+
+<div align="center">
+
+![GitHub Repo stars](https://img.shields.io/github/stars/JackySoft/marsview)
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/JackySoft/marsview)
+![GitHub License](https://img.shields.io/github/license/JackySoft/marsview)
+![version](https://img.shields.io/npm/v/amis)
+![language](https://img.shields.io/github/languages/top/JackySoft/marsview)
+![last](https://img.shields.io/github/last-commit/JackySoft/marsview.svg)
+
+</div>
+
+## 介绍 🚀
+
 Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上完成项目和页面的闭环，支持事件交互、接口调用、数据联动和逻辑编排等，开发者可通过微服务快速集成到自己的业务系统中。
 
-## 快速开始
+## 在线使用 🛸
+
+- 🌍 [Marsview](http://www.marsview.cc/)
+
+|                                    |                                    |
+| ---------------------------------- | ---------------------------------- |
+| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
+| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
+| ![Demo](./.github/imgs/intro5.png) | ![Demo](./.github/imgs/intro6.png) |
+
+## 特色 💥
+
+- **项目：**
+  项目创建、项目配置（主题色、菜单布局、系统 Logo、面包屑...）、项目菜单创建、项目角色创建、用户管理；
+  基于 RBAC 的权限管理。创建项目后，可以直接通过 [http://admin.marsview.cc](http://admin.marsview.cc) 去访问配置的项目。
+- **页面：** 页面创建、页面主题、页面配置、组件拖拽、组件属性、组件事件、组件数据。
+  目前完全可用于生产环境，项目在创建菜单时可以关联该页面。
+  页面同时支持其他传统系统通过微服务集成，不管你的系统是 Vue 还是 React。
+- **页面组件：** 目前支持的组件有：按钮、表单（所有表单组件）、表格、图表、弹窗、图片、富文本、文件上传、文件下载、代码编辑器、编辑表格、iframe 等常用的页面组件。表单支持了常用规则验证和自定义规则验证。
+- **自定义组件：** 自带页面组件满足不了需求时可以自定义开发相关组件，支持 jsx 语法，less 和事件。
+- **接口：** 接口、口创建、接口配置，支持 GET、POST、PUT、DELETE 等请求方式，支持接口参数传递。
+- **事件流：** 通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、逻辑处理等。
+
+## 本地开发 👨‍💻
+
+```bash
+# 克隆代码
+git clone https://github.com/JackySoft/marsview.git
+```
+
+### 快速开始
+
+运行需要 node 环境，建议`node:18`以上版本。使用`pnpm`作为依赖管理工具，如未安装，请先执行安装命令`npm install -g pnpm`。
 
 ```bash
-# 安装依赖
+# 进入根目录
+cd marsview
+
+# 安装依赖（安装依赖时间如过长，请先配置镜像源）
 pnpm i
 # 启动编辑器
 pnpm start:editor
 # 启动用户端
 pnpm start:admin
+# 启动文档
+pnpm start:docs
 ```
 
-## 同步代码
+### 同步代码
 
-```
-# add upstream
+项目处于高速开发阶段，版本更新较快，建议开发者 `fork` 和 `clone` 项目后，设置上流远程分支，随时拉取最新代码同步本地。
+
+```bash
+# 添加上流分支
 
 git remote add upstream https://github.com/JackySoft/marsview
 
@@ -31,14 +96,52 @@ git checkout main
 # 合并远程分支
 
 git merge upstream/main
-
 ```
 
-## 功能介绍
+## 活动记录 🆕
+
+- 2024-08-17: 项目[在线文档](http://docs.marsview.cc/)发布
+- 2024-08-13: 开源文章登上掘金论坛热榜第一
+  - 掘金[文章热榜](https://juejin.cn/hot/articles/)
+- 2024-08-10: 项目开源
+  - 公告项目开源，发布开源文章：[我的低代码平台 Marsview 终于开源了](https://juejin.cn/post/7401009128204894244)
+- 2024-07-16: 项目首次在掘金论坛预告
+  - 发布预告文章：[我花了 8 个月，做了一款高颜值零代码平台 Mars](https://juejin.cn/post/7392071348480835595)
+
+## 更新日志 📅
+
+查看 [更新日志](https://github.com/JackySoft/marsview/blob/master/CHANGELOG.md) 获取最新更新情况。
+
+## 项目交流 🏘️
+
+在使用和开发过程中遇到任何问题，欢迎微信扫码添加项目交流群：
+
+<img src="https://marsview.cdn.bcebos.com/qrcode.jpg" alt="交流群" width="300">
+
+## 🤝 参与贡献
+
+这个项目的存在感谢项目中所有的贡献者。
+
+我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues](https://github.com/JackySoft/marsview/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)，大展身手，向我们展示你的奇思妙想。
+
+如何你想成为开发者，欢迎提交`PR`，提交`PR`规范请参考：[Pull Rquest](.github/PULL_REQUEST_TEMPLATE.md)
+
+<a href="https://github.com/JackySoft/marsview/graphs/contributors" target="_blank">
+<img src="https://contrib.rocks/image?repo=JackySoft/marsview">
+</a>
+
+## Star History 🌟
+
+如果你发现此项目对你有所帮助，请考虑在 [GitHub](https://github.com/JackySoft/marsview) 上给它一个 ⭐️ !
+<a href="https://github.com/JackySoft/marsview/stargazers" target="_blank" style="display: block" align="center">
+<picture>
+
+<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date&theme=dark" />
+<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date" />
+<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date" />
+</picture>
+</a>
+
+## 许可证 📄
 
-- 项目：项目创建、项目配置（主题色、菜单布局、系统 Logo、面包屑...）、项目菜单创建、项目角色创建、用户管理；其实是一整套基于 RBAC 的权限管理。创建项目后，可以直接通过 http://admin.marsview.cc 去访问配置的项目。
-- 页面：页面创建、页面主题、页面配置、组件拖拽、组件属性、组件事件、组件数据。目前完全可用于生产环境，项目在创建菜单时可以关联该页面。页面同时支持其他传统系统通过微服务集成，不管你的系统是 Vue 还是 React。
-- 页面组件：目前支持的组件有：按钮、表单（所有表单组件）、表格、图表、弹窗、图片、富文本、文件上传、文件下载、代码编辑器、编辑表格、iframe 等常用的页面组件。表单支持了常用规则验证和自定义规则验证。
-- 接口：接口创建、接口配置，支持 GET、POST、PUT、DELETE 等请求方式，支持接口参数传递。
-- 事件流：通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、逻辑处理等。
-- 组件库：对于常用的页面组件如果无法满足，可以自定义组件。
+此项目根据 MIT 许可证授权 - 有关详细信息，请参阅 [LICENSE](https://github.com/JackySoft/marsview/blob/main/LICENSE) 文件。

package.json

@@ -21,6 +21,8 @@
     "build:editor": "pnpm --filter editor build",
     "start:admin": "pnpm --filter admin start",
     "build:admin": "pnpm --filter admin build",
+    "start:docs": "pnpm --filter docs dev",
+    "build:docs": "pnpm --filter docs build",
     "build": "rm -rf dist && pnpm --filter editor build && pnpm --filter admin build && pnpm --filter docs build",
     "prettier": "prettier --write '**/*.{js,jsx,tsx,ts,less,md,json}'",
     "release:major": "standard-version --release-as major",

packages/docs/.vitepress/config.mts

@@ -5,9 +5,13 @@ export default defineConfig({
   title: 'Marsview',
   description: '一款面向中后台低代码平台，支持逻辑编排、事件交互和接口配置。',
   lastUpdated: true,
+  head: [['link', { rel: 'icon', href: '/mars-logo.png' }]],
+  lang: 'zh-CN',
+  srcDir: 'src',
+  outDir: '../../dist/docs',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
-    logo: './../assets/mars-logo.png',
+    logo: '/mars-logo.png',
     nav: [
       { text: '首页', link: '/' },
       { text: '项目', link: '/project' },
@@ -57,7 +61,7 @@ export default defineConfig({
     socialLinks: [{ icon: 'github', link: 'https://github.com/JackySoft/marsview' }],
     footer: {
       message: 'Released under the MIT License.',
-      copyright: 'Copyright © 2014-present 河畔一角',
+      copyright: 'Copyright © 2024-present 河畔一角',
     },
     search: {
       provider: 'local',

packages/docs/.vitepress/theme/custom.css

@@ -0,0 +1,5 @@
+:root {
+  --vp-c-brand-1: #7d33ff;
+  --vp-c-brand-2: #9d5cff;
+  --vp-button-brand-bg: #7d33ff;
+}

packages/docs/.vitepress/theme/index.ts

@@ -0,0 +1,5 @@
+// .vitepress/theme/index.js
+import DefaultTheme from 'vitepress/theme';
+import './custom.css';
+
+export default DefaultTheme;

packages/docs/package.json

@@ -3,8 +3,8 @@
   "version": "1.0.0",
   "description": "Marsview低代码平台开发使用文档",
   "scripts": {
-    "docs:dev": "vitepress dev",
-    "build": "vitepress build && mv ./.vitepress/dist ../../dist/docs",
+    "dev": "vitepress dev",
+    "build": "vitepress build",
     "docs:preview": "vitepress preview"
   },
   "author": "河畔一角",

packages/docs/index.md → packages/docs/src/index.md

@@ -7,11 +7,11 @@ hero:
   text: '快速搭建后台管理系统'
   tagline: 让搭建更简单，让开发更高效
   image:
-    src: http://www.marsview.cc/imgs/welcome-bg.png
+    src: http://www.marsview.cc/imgs/login-bg.png
     alt: Marsview
   actions:
     - theme: brand
-      text: 使用文档
+      text: 快速开始
       link: /login
     - theme: alt
       text: 在线体验

packages/docs/lib/index.md → packages/docs/src/lib/index.md

@@ -8,13 +8,13 @@
 
 组件标识为英文，类似于`Antd`组件库中的`Button`，组件名称为中文。
 
-![创建组件](./../assets/lib/createLib.png)
+![创建组件](/lib/createLib.png)
 
 ## 组件开发
 
 组件创建完成后，在列表点击开发按钮，即可进入开发界面。
 
-![组件开发](./../assets/lib/dev.png)
+![组件开发](/lib/dev.png)
 
 ## 开发流程
 

packages/docs/login.md → packages/docs/src/login.md

@@ -2,15 +2,15 @@
 
 ### 打开 Marsview
 
-输入平台地址：`http://marsview.com`
+输入平台地址：`http://marsview.cc`
 
-![进入首页](./assets/login/welcome.png)
+![进入首页](/login/welcome.png)
 
 ### 进入登录页面
 
 点击快速开始按钮，如果没有登录，会跳转到登录页面。
 
-![点击快速开始](./assets/login/login.png)
+![点击快速开始](/login/login.png)
 
 ### 登录账号