refactor(mono): 组件库文档补充更新日志(changelog-needed)

bin-K · bin-K · commit 2fd46d9a92d2 · 2024-04-30T16:16:04.000+08:00
ISSUES CLOSED: none
diff --git a/README.md b/README.md
@@ -4,6 +4,6 @@
 
 - 参考：https://github.com/bin-K/monorepo-pnpm-vue
 
-#### docs
+#### 组件库文档
 
-- https://bin-k.github.io/ued-ui/components/button/
+- https://bin-k.github.io/ued-ui/
diff --git a/play/index.html b/play/index.html
@@ -4,6 +4,7 @@
 		<meta charset="UTF-8" />
 		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
 		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<link rel="icon" href="/favicon.svg" />
 		<title>play</title>
 	</head>
 	<body>
diff --git a/play/public/favicon.svg b/play/public/favicon.svg
@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1714443312485" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="3651" width="500" height="500" xmlns:xlink="http://www.w3.org/1999/xlink"><path d="M157.805714 647.131429a27.428571 27.428571 0 0 1 36.205715-13.897143L512 774.546286l317.988571-141.312a27.428571 27.428571 0 0 1 22.308572 50.102857l-329.142857 146.285714a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285714a27.428571 27.428571 0 0 1-13.897143-36.205714z" fill="#1296db" p-id="3652"></path><path d="M157.805714 500.845714a27.428571 27.428571 0 0 1 36.205715-13.897143L512 628.260571l317.988571-141.312a27.428571 27.428571 0 0 1 22.308572 50.102858l-329.142857 146.285714a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285714a27.428571 27.428571 0 0 1-13.897143-36.205715z" fill="#1296db" p-id="3653"></path><path d="M500.845714 194.377143a27.428571 27.428571 0 0 1 22.308572 0l329.142857 146.285714a27.428571 27.428571 0 0 1 0 50.102857l-329.142857 146.285715a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285715a27.428571 27.428571 0 0 1 0-50.102857l329.142857-146.285714zM250.404571 365.714286L512 482.011429 773.595429 365.714286 512 249.417143 250.404571 365.714286z" fill="#1296db" p-id="3654"></path></svg>
diff --git a/site/docs/.vitepress/config.js b/site/docs/.vitepress/config.js
@@ -1,27 +1,104 @@
 export default {
 	base: process.env.NODE_ENV === 'production' ? '/ued-ui/' : '/',
+	head: [
+		[
+			'link',
+			{
+				rel: 'icon',
+				href:
+					(process.env.NODE_ENV === 'production' ? '/ued-ui/' : '/') +
+					'favicon.svg',
+			},
+		],
+	],
 	themeConfig: {
 		siteTitle: 'Ued-Plus',
+		outline: {
+			level: 'deep',
+		},
 		nav: [
-			{ text: '指南', link: '/guide/installation/' },
+			{ text: '更新日志', link: '/changelogs/mono/' },
+			{ text: '指南', link: '/guide/quickstart/' },
 			{ text: '组件', link: '/components/button/' },
 		],
 		socialLinks: [
 			{ icon: 'github', link: 'https://github.com/bin-K/ued-plus' },
 		],
 		sidebar: {
-			'/guide/': [
+			'/changelogs': [
 				{
-					text: '基础',
+					text: '基础日志',
 					items: [
 						{
-							text: '安装',
-							link: '/guide/installation/',
+							text: 'Mono',
+							link: '/changelogs/mono/',
+						},
+					],
+				},
+				{
+					text: '基础组件',
+					items: [
+						{
+							text: 'Button',
+							link: '/changelogs/button/',
+						},
+						{
+							text: 'Icon',
+							link: '/changelogs/icon/',
+						},
+						{
+							text: 'Text',
+							link: '/changelogs/text/',
+						},
+						{
+							text: 'Link',
+							link: '/changelogs/link/',
+						},
+						{
+							text: 'Container',
+							link: '/changelogs/container/',
+						},
+						{
+							text: 'Layout',
+							link: '/changelogs/layout/',
 						},
+						{
+							text: 'Scrollbar',
+							link: '/changelogs/scrollbar/',
+						},
+					],
+				},
+				{
+					text: '表单组件日志',
+					items: [
+						{
+							text: 'Radio',
+							link: '/changelogs/radio/',
+						},
+					],
+				},
+				{
+					text: '反馈组件日志',
+					items: [
+						{
+							text: 'Dialog',
+							link: '/changelogs/dialog/',
+						},
+					],
+				},
+			],
+			'/guide/': [
+				{
+					text: '基础',
+					items: [
 						{
 							text: '快速开始',
 							link: '/guide/quickstart/',
 						},
+						{
+							text: '安装',
+							link: '/guide/installation/',
+						},
 					],
 				},
 			],
diff --git a/site/docs/changelogs/button/index.md b/site/docs/changelogs/button/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/button.md-->
diff --git a/site/docs/changelogs/container/index.md b/site/docs/changelogs/container/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/container.md-->
diff --git a/site/docs/changelogs/dialog/index.md b/site/docs/changelogs/dialog/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/dialog.md-->
diff --git a/site/docs/changelogs/icon/index.md b/site/docs/changelogs/icon/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/icon.md-->
diff --git a/site/docs/changelogs/layout/index.md b/site/docs/changelogs/layout/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/layout.md-->
diff --git a/site/docs/changelogs/link/index.md b/site/docs/changelogs/link/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/link.md-->
diff --git a/site/docs/changelogs/mono/index.md b/site/docs/changelogs/mono/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/mono.md-->
diff --git a/site/docs/changelogs/radio/index.md b/site/docs/changelogs/radio/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/radio.md-->
diff --git a/site/docs/changelogs/scrollbar/index.md b/site/docs/changelogs/scrollbar/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/scrollbar.md-->
diff --git a/site/docs/changelogs/text/index.md b/site/docs/changelogs/text/index.md
@@ -0,0 +1 @@
+<!--@include: ../../../../changelogs/text.md-->
diff --git a/site/docs/guide/installation/index.md b/site/docs/guide/installation/index.md
@@ -1,36 +1,42 @@
 # 安装
 
-## clone 组件库代码
+## 项目引入前置
+
+> 完成组件库推送私服后，项目根目录下创建`.npmrc`文件，并配置私服地址
+
+```js
+registry=http://127.0.0.1:8081/repository/npm-hosted/
+```
+
+> 需要进行`npm login`
 
 ```shell
-git clone git@github.com:bin-K/ued-plus.git
+npm login --registry=http://127.0.0.1:8081/repository/npm-hosted/
 ```
 
-## 进入组件库并执行依赖安装
+## 执行依赖安装
 
 ```shell
-cd ued-plus
-pnpm i
+pnpm add ued-plus
 ```
 
-## 使用 nexus 搭建本地npm 私服
+## 全局引用
 
-- 主要参考：
-- 安装nexus: https://juejin.cn/post/7244450987703304253
-- 配置nexus仓库：https://www.cnblogs.com/54chensongxia/p/14930128.html
-- 发布本地依赖包到私服仓库：https://blog.csdn.net/wjyyhhxit/article/details/103595333
+```ts
+// main.ts
+import UedPlus from 'ued-plus'
+app.use(UedPlus)
+```
 
-> [!CAUTION]
-> 踩坑：npm login 登录http://locahost:8081/repository/npm-hosted/ 时可能会出错，
-> 因为此时localhost 可能为::1，此时ping localhost 返回的是::1而不是127.0.0.1
-> 因此将localhost 统一为127.0.0.1
-> 具体参考：
-> https://github.com/node-fetch/node-fetch/issues/1624
-> https://superuser.com/questions/414050/why-is-there-a-difference-between-ping-localhost-and-ping-local-ip-address
+## 局部引用
 
-## 执行本地组件库打包和发布命令
+```vue
+*.vue
+<template>
+	<ued-button>默认按钮</ued-button>
+</template>
 
-```shell
-pnpm run build:ued-plus
-pnpm run publish:ued-plus
+<script lang="ts" setup>
+import { UedButton } from 'ued-plus'
+</script>
 ```
diff --git a/site/docs/guide/quickstart/index.md b/site/docs/guide/quickstart/index.md
@@ -1,35 +1,34 @@
-## 其他项目引入
+# 搭建本地npm私服并发布组件库
 
-- 项目根目录下创建.npmrc文件，并配置私服地址
-- 需要进行npm login
+## clone 组件库代码
 
-```
-registry=http://127.0.0.1:8081/repository/npm-hosted/
+```shell
+git clone git@github.com:bin-K/ued-plus.git
 ```
 
-## 执行依赖安装
+## 进入组件库并执行依赖安装
 
 ```shell
-pnpm add ued-plus
+cd ued-plus
+pnpm i
 ```
 
-## 全局引用
+## 使用 nexus 搭建本地npm 私服
 
-```ts
-// main.ts
-import UedPlus from 'ued-plus'
-app.use(UedPlus)
-```
+> 主要参考：<br>
+> 安装nexus: `https://juejin.cn/post/7244450987703304253`<br>
+> 配置nexus仓库：`https://www.cnblogs.com/54chensongxia/p/14930128.html`<br>
+> 发布本地依赖包到私服仓库：`https://blog.csdn.net/wjyyhhxit/article/details/103595333`
 
-## 局部引用
+> [!CAUTION] 踩坑
+> npm login 登录 `http://locahost:8081/repository/npm-hosted/` 时可能会出错<br>
+> 因为此时localhost 可能为::1，此时ping localhost 返回的是::1而不是127.0.0.1<br>
+> 因此将localhost 统一为127.0.0.1<br>
+> 具体参考：<br> `https://github.com/node-fetch/node-fetch/issues/1624`<br>`https://superuser.com/questions/414050/why-is-there-a-difference-between-ping-localhost-and-ping-local-ip-address`
 
-```vue
-*.vue
-<template>
-	<ued-button>默认按钮</ued-button>
-</template>
+## 执行本地组件库打包和发布命令
 
-<script lang="ts" setup>
-import { UedButton } from 'ued-plus'
-</script>
+```shell
+pnpm run build:ued-plus
+pnpm run publish:ued-plus
 ```
diff --git a/site/docs/public/favicon.svg b/site/docs/public/favicon.svg
@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1714443312485" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="3651" width="500" height="500" xmlns:xlink="http://www.w3.org/1999/xlink"><path d="M157.805714 647.131429a27.428571 27.428571 0 0 1 36.205715-13.897143L512 774.546286l317.988571-141.312a27.428571 27.428571 0 0 1 22.308572 50.102857l-329.142857 146.285714a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285714a27.428571 27.428571 0 0 1-13.897143-36.205714z" fill="#1296db" p-id="3652"></path><path d="M157.805714 500.845714a27.428571 27.428571 0 0 1 36.205715-13.897143L512 628.260571l317.988571-141.312a27.428571 27.428571 0 0 1 22.308572 50.102858l-329.142857 146.285714a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285714a27.428571 27.428571 0 0 1-13.897143-36.205715z" fill="#1296db" p-id="3653"></path><path d="M500.845714 194.377143a27.428571 27.428571 0 0 1 22.308572 0l329.142857 146.285714a27.428571 27.428571 0 0 1 0 50.102857l-329.142857 146.285715a27.428571 27.428571 0 0 1-22.308572 0l-329.142857-146.285715a27.428571 27.428571 0 0 1 0-50.102857l329.142857-146.285714zM250.404571 365.714286L512 482.011429 773.595429 365.714286 512 249.417143 250.404571 365.714286z" fill="#1296db" p-id="3654"></path></svg>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!--@include: ../../../../changelogs/button.md-->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!--@include: ../../../../changelogs/container.md-->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!--@include: ../../../../changelogs/dialog.md-->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!--@include: ../../../../changelogs/icon.md-->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!--@include: ../../../../changelogs/layout.md-->`