zh-cn/docs: 修改README.md和_sidebar.md

wonder-light · Dec 31, 2024 · c266f84 · c266f84
1 parent f48b297
commit c266f84
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 7 deletions.
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
@@ -1,3 +1,7 @@
+:root {
+  --app-name-img-width: 80px;
+}
+
 .p-big {
   font-size: 1.4rem;
   font-weight: 700;
@@ -72,4 +76,9 @@
 .b-main-hide section.content {
   transform: none !important;
   left: 0 !important;
+}
+
+/* logo 图片 */
+a.app-name-link img {
+  width: var(--app-name-img-width);
 }
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
@@ -19,8 +19,9 @@ function hideEmptySidebar(hook, vm) {
 
 // docsify 配置
 window.$docsify = {
-  name: "",
+  name: "glidea",
   repo: "",
+  logo: "/assets/images/logo.png",
   // 禁用相对路径
   relativePath: false,
   basePath: "/",
@@ -40,6 +41,10 @@ window.$docsify = {
   // 路由模式
   routerMode: "history",
   formatUpdated: "{YYYY}/{MM}/{DD} {HH}:{mm}:{ss}",
+  alias: {
+    "/.*/_navbar.md": "/_navbar.md",
+    "/([a-z]*-[a-z]*)/docs/.*/_sidebar.md": "/$1/docs/_sidebar.md",
+  },
   plugins: [hideEmptySidebar],
   // vue 全局选项
   vueGlobalOptions: {

diff --git a/docs/index.html b/docs/index.html
@@ -9,13 +9,13 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
   <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
   <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar.min.css" />
-  <link rel="stylesheet" href="./assets/css/main.css">
+  <link rel="stylesheet" href="/assets/css/main.css">
 </head>
 
 <body>
   <div id="app"></div>
   <!-- docsify 配置 -->
-  <script src="./assets/js/main.js"></script>
+  <script src="/assets/js/main.js"></script>
   <!-- Docsify v4 -->
   <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
   <!-- 表情 -->

diff --git a/docs/zh-cn/docs/README.md b/docs/zh-cn/docs/README.md
@@ -1,3 +1,58 @@
-# 文档
+
+# Glidea
 
-[filename](./github.md ':include')
+> 一个静态博客写作客户端
+
+<br>
+
+# 概述
+
+Glidea 可以帮助你更容易地构建并管理博客或任何静态站点, 你可以用它来记录你的生活、心情、知识、笔记、创意等等
+
+查看[快速开始](zh-cn/docs/start/quick.md)了解详情
+
+<br>
+
+# 特性👇
+
+- 📝  你可以使用简洁的 **Markdown** 语法，进行快速创作
+
+- 🌉  你可以给文章配上精美的封面图和在文章任意位置插入图片
+
+- 🏷️  你可以对文章进行标签分组
+
+- 📋  你可以自定义菜单，可以创建外部链接菜单
+
+- 💻  你可以在桌面端或移动端设备上使用此客户端
+
+- 🌎  你可以使用 **𝖦𝗂𝗍𝗁𝗎𝖻 𝖯𝖺𝗀𝖾𝗌** 或 **Coding Pages** 向世界展示，未来将支持更多平台
+
+<!--
+- 💬  你可以进行简单的配置，接入 [Gitalk](https://github.com/gitalk/gitalk) 或 [DisqusJS](https://github.com/SukkaW/DisqusJS) 评论系统
+-->
+
+- 🗺️  你可以使用**中文简体**、**英语**等等
+
+- 🌁  你可以任意使用默认主题或任意第三方主题，有强大的主题自定义能力
+
+- 🖥  你可以自定义源文件夹，利用 OneDrive、百度网盘等进行多设备同步
+
+<br>
+
+# 开发
+
+如果你想贡献代码，请提前参阅[贡献指南](https://github.com/wonder-light/glidea/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
+
+<br>
+
+# 捐赠
+
+如果你觉得 glidea 对你有帮助，或者想对我微小的工作一点资瓷，欢迎给我捐赠
+
+![donate](../../assets/images/reward_qrcode.png ':size=280')
+
+<br>
+
+# License
+
+[MIT](https://github.com/wonder-light/glidea/blob/main/LICENSE). Copyright (c) 2024 wonder-light
diff --git a/docs/zh-cn/docs/_sidebar.md b/docs/zh-cn/docs/_sidebar.md
@@ -1,7 +1,13 @@
 <!-- _sidebar.md -->
 
-*[简介](/zh-cn/docs/readme.md)
 * 入门
+  * [简介](zh-cn/docs/)
+  * [快速开始](zh-cn/docs/start/quick.md)
+* 主题
+  * [开发](zh-cn/docs/theme/dev.md)
+  * [结构](zh-cn/docs/theme/struct.md)
+  * [变量](zh-cn/docs/theme/var.md)
+  * [自定义](zh-cn/docs/theme/custom.md)
 * 指南
-  * [常见问题](zh-cn/docs/faq.md)
+  * [常见问题](zh-cn/docs/guide/faq.md)
 * [Changelog](zh-cn/docs/changelog.md)
diff --git a/docs/zh-cn/docs/changelog.md b/docs/zh-cn/docs/changelog.md
@@ -0,0 +1,2 @@
+
+[filename](https://raw.githubusercontent.com/wonder-light/glidea/refs/heads/main/CHANGELOG.md ':include')
diff --git a/docs/zh-cn/docs/guide/faq.md b/docs/zh-cn/docs/guide/faq.md
@@ -0,0 +1 @@
+# faq
diff --git a/docs/zh-cn/docs/start/quick.md b/docs/zh-cn/docs/start/quick.md
@@ -0,0 +1,5 @@
+<!-- quick.md -->
+
+# 快速开始
+
+# 看看
diff --git a/docs/zh-cn/docs/theme/custom.md b/docs/zh-cn/docs/theme/custom.md
@@ -0,0 +1 @@
+# custom
diff --git a/docs/zh-cn/docs/theme/dev.md b/docs/zh-cn/docs/theme/dev.md
@@ -0,0 +1 @@
+# dev
diff --git a/docs/zh-cn/docs/theme/struct.md b/docs/zh-cn/docs/theme/struct.md
@@ -0,0 +1 @@
+# struct
diff --git a/docs/zh-cn/docs/theme/var.md b/docs/zh-cn/docs/theme/var.md
@@ -0,0 +1 @@
+# var
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@

		[filename](https://raw.githubusercontent.com/wonder-light/glidea/refs/heads/main/CHANGELOG.md ':include')