2021.08.09 背Ta单词官方文档优化

docs/README.md

@@ -1,5 +1,8 @@
 
-?> 目前项目还在开发中，请过段时间再来看吧。
+!> 目前项目还在开发中，请过段时间再来看吧。
+
+<!-- 项目开发进度 -->
+[contact](include/development-progress.md ':include')
 
 <p align="center">
   <!-- <a href="https://tawords.com" target="_blank"> -->
@@ -18,14 +21,14 @@
 
 </div>
 
-------------
+<!-- ## 背Ta单词 - tawords --> <!-- {docsify-ignore} -->
 
 <!-- 背Ta单词 简介 -->
 [intro](include/intro.md ':include')
 
 ------------
 
-## 传送门 - Navigation
+## 传送门 - Navigation <!-- {docsify-ignore} -->
 
 | 背Ta单词 | 网址 |
 |------|------|
@@ -38,27 +41,20 @@
 
 ------------
 
-## 联系我们 - Contact Us
+## 联系我们 - Contact Us <!-- {docsify-ignore} -->
 
 <!-- 联系我们 -->
-[contact](manual/about/contact.md ':include')
+[contact](include/contact.md ':include')
 
 ------------
 
-## 支持项目发展 - Rewards
+## 支持项目发展 - Rewards <!-- {docsify-ignore} -->
 
 <!-- 支持项目发展 -->
 [reward](include/reward.md ':include')
 
 ------------
 
-## 开源许可证 - Licence
+## 开源许可证 - Licence <!-- {docsify-ignore} -->
 
 本项目使用 GPL-3.0 许可证许可，如果您对该许可证不了解，请查看“关于”目录下许可证的中文非正式版本。如果您希望在许可证允许的范围外使用本项目，可以通过“关于->联系”的联系方式与我们取得联系。
-
-------------
-
-## 说明 - Elucidation
-
-限于精力和能力有限，目前暂时只有网页版，无小程序端、安卓端、iOS端、PC端。后续如果项目使用的人数较多，将会按照小程序端→PC端/安卓端→iOS端的顺序依次开发，如果项目使用的人不多，将不会考虑这些平台。但是待应用中心上线后，
-

docs/_404.md

@@ -1,4 +1,4 @@
-# 404 未找到
+# 404 未找到 <!-- {docsify-ignore} -->
 
 你所访问的页面不存在或已被删除！
 
@@ -8,7 +8,7 @@
 ----------
 
 
-# 404 Not found
+# 404 Not found <!-- {docsify-ignore} -->
 
 The page you visited does not exist or has been deleted.
 

docs/_navbar.md

@@ -1,6 +1,6 @@
-- [主页](https://www.reciteword.com/ "背Ta单词官方网站")
+- [项目主页(暂未上线)](https://tawords.com/ "背Ta单词项目主页")
 
-- 文档
+- [文档](/README "背Ta单词官方网站")
 	- [快速开始](/manual/start/introduction)
 	- [使用说明](/manual/instructions/start-using)
 	- [接口文档](/manual/api/introduction)
@@ -9,14 +9,17 @@
 	- [关于](/manual/about/)
 	- [版本信息](/manual/instructions/start-using)
 
-- [应用中心(暂未上线)](https:/// "应用中心")
+- 传送门
+    - [应用中心(暂未上线)](https://app.tawords.com/ "应用中心")
+    - [社区(暂未上线)](https://club.tawords.com/ "社区")
+    - [演示站点(暂未上线)](https://demo.tawords.com/ "演示站点")
 
-- [交流中心(暂未上线)](https:/// "交流中心")
+- [官方运营网站](https://www.reciteword.com/ "背Ta单词官方网站")
 
-- [<img src="static/images/gitee.svg" style="height: 26px; vertical-align: text-bottom;" />](https://gitee.com/ "背Ta单词 Gitee repo") <!-- [<img src="static/images/github.svg" style="height: 26px; vertical-align: text-bottom;" />](https://gitee.com/ "背Ta单词 GitHub repo") -->
+- [<img src="static/images/gitee.svg" style="height: 26px; vertical-align: text-bottom;" />](https://gitee.com/tawords/ "背Ta单词 Gitee repo")
+- [<img src="static/images/github.svg" style="height: 26px; vertical-align: text-bottom;" />](https://github.com/tawords/ "背Ta单词 GitHub repo")(暂未上线)
 
 <!--
-
 - [![gitee](static/images/gitee.svg)(暂未上线)](https://gitee.com/ "背Ta单词 Gitee repo")
 - [![github](static/images/github.svg)(暂未上线)](https://github.com/ "背Ta单词 GitHub repo")
 -->

docs/_sidebar.md

@@ -8,7 +8,8 @@
 	- [7. 网站备份（需要更新）](/manual/start/backup)
 	- [8. 网站迁移（TODO）](/manual/start/migration)
 	- [9. 目录结构（TODO）](/manual/start/directory-structure)
-	- [10. 常见问题](/manual/start/faq)
+	- [10. 支持平台](/manual/start/platform)
+	- [11. 常见问题](/manual/start/faq)
 
 - **二、使用说明**
 	- [1. 开始使用（撰写中）](/manual/instructions/start-using)
@@ -50,9 +51,9 @@
 
 	- [特别鸣谢](/manual/about/acknowledgement)
 	- [使用的开源组件列表](/manual/about/open-source-project)
-    - [法律声明及服务协议]()
-        - [开源许可证 GPL-3.0](/manual/about/License/GPL-3.0)
-        - [更好的理解 GPL-3.0](/manual/about/License/have-a-better-understanding-of-GPL-3.0)
+    - [法律声明及服务协议](/manual/about/license/README)
+        - [开源许可证 GPL-3.0](/manual/about/license/GPL-3.0)
+            - [更好的理解 GPL-3.0](/manual/about/license/have-a-better-understanding-of-GPL-3.0)
         - 法律声明 policy
             - [版权声明 Copyright](/manual/about/policy/copyright)
             - [免责声明 Disclaimer](/manual/about/policy/disclaimer)

docs/include/contact.md

@@ -0,0 +1,15 @@
+
+<!-- 背Ta单词 简介 -->
+[联系邮箱](./email.md ':include')
+
+如果您发现了Bug，请备注`BUG`
+如果您有更好的电子或建议，请备注`建议`
+如果您想要与我们取得合作，请备注`合作`，我们十分欢迎您的合作，但下列情况除外：
+
+> - 交换友链
+> - 广告
+> - 推销产品，服务（包括但不限于SEO优化等）
+
+最后，感谢您的支持！
+
+<!-- include/contact.md -->

docs/include/development-progress.md

@@ -0,0 +1,9 @@
+##### 【项目开发进度】 <!-- {docsify-ignore} -->
+
+- 官方文档：正在编写
+- 项目代码：正在重构
+- 官方网站：域名正在备案
+- 社区：等待排期
+- 应用中心：等待排期
+
+<!-- include/development-progress.md -->

docs/include/email.md

@@ -1,3 +1,4 @@
 联系邮箱：`admin@only4.work`
+（请备注来意，否则不予回复）
 
 <!-- include/email.md -->

docs/include/intro.md

@@ -1,5 +1,3 @@
-## 背Ta单词 - tawords
-
 > “背Ta单词”是一款网页版在线背单词系统，主打图表背单词。在背单词的过程中，显示相关单词记忆数据图表，用图表背单词，用大数据背单词，就是快！
 
 本项目基于PHP平台，使用MySQL数据库。在众多框架流行的今天，反其道而行之，后端不使用第三方框架，使用原生PHP开发，快捷高效，同时可以轻易部署到云服务器、云虚拟主机等多种环境中，十分灵活。

docs/index.html

@@ -132,20 +132,51 @@
 				},
 
 				plugins: [
-					// 添加文档修改时间 和 发现文档中的错误？去Gitee上编辑当前页面
-					function(hook, vm) { // auto_add_update_time_plugin
+					// 添加文档修改时间 和 在Gitee上编辑（发现文档中的错误？去Gitee上编辑当前页面）
+					function(hook, vm) {
 						hook.beforeEach(function(content) {
-							var updateHTML = '<p align="right" style="opacity: 0.6;">更新时间：{docsify-updated}</p>' +
-											 '<p align="center" style="margin: 80px auto;">' +
-											 '<span style="background-color: #c9f0ff; padding: 40px 80px;">发现文档中的错误？有更好的修改建议？' +
-												 '<a href=""></a>去Gitee上编辑当前页面！' +
-											 '<span>' +
-											 '</p>'
-							content = content + updateHTML
-							return content;
+							var url = 'https://gitee.com/tawords/tawords-docs/blob/master/docs/' + vm.route.file;
+							
+							var editHtml = '\n[📝 在Gitee上编辑当前文档](' + url + ')\n';
+							
+							var updateTimeHtml = '\n\n' + '<p align="right" style="opacity: 0.6;">更新时间：{docsify-updated}</p>' + '\n\n';
+
+							var editHtml2 = 
+								'<div style="margin: 80px auto;">' +
+									'<p align="center" style="background-color: #c9f0ff; padding: 40px 10px; line-height: 2.2em;">' +
+										'<nobr>发现文档中的错误？</nobr><nobr>有更好的修改建议？</nobr><br>' +
+										'<a href="' + url + '" target="_blank">📝 在Gitee上编辑当前文档！</a>' +
+									'</p>' +
+								'</div>';
+
+							// Gitee仓库贡献请求Api：
+							// https://gitee.com/api/v5/repos/tawords/tawords/contributors
+							// https://gitee.com/api/v5/repos/tawords/tawords-docs/contributors
+
+							return (
+								editHtml +
+								content +
+								updateTimeHtml +
+								editHtml2
+							);
 						});
 					},
 
+					// 添加footer
+					// function(hook) {
+					// 	var footer = [
+					// 		'<hr/>',
+					// 		'<footer>',
+					// 		'<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
+					// 		'<span>Proudly published with <a href="https://github.com/docsifyjs/docsify" target="_blank">docsify</a>.</span>',
+					// 		'</footer>'
+					// 	].join('');
+
+					// 	hook.afterEach(function(html) {
+					// 		return html + footer;
+					// 	});
+					// },
+
 					// 左侧菜单滚动到激活的位置
 					function(hook, vm) {
 						scrollToHandler = function() {

docs/manual/about/contact.md

@@ -1,13 +1,6 @@
+## 联系我们 - Contact Us <!-- {docsify-ignore} -->
 
-<!-- 背Ta单词 简介 -->
-[联系邮箱](../../include/email.md ':include')
 
-如果您发现了Bug，请备注`BUG`
-如果您有更好的电子或建议，请备注`建议`
-如果您想要与我们取得合作，请备注`合作`，我们十分欢迎您的合作，但下列情况除外：
+<!-- 联系我们 -->
+[contact](../../include/contact.md ':include')
 
-> - 交换友链
-> - 广告
-> - 推销产品，服务（包括但不限于SEO优化等）
-
-最后，感谢您的支持！

docs/manual/about/license/README.md

@@ -0,0 +1 @@
+### 点击左侧菜单以继续 <!-- {docsify-ignore} -->

docs/manual/about/third-party-interface.md

@@ -1,3 +1,3 @@
-### 使用第三方接口
+### 使用第三方接口 <!-- {docsify-ignore} -->
 
 有道翻译：单词读音接口（感谢有道的免费服务！）

docs/manual/start/platform.md

@@ -0,0 +1,13 @@
+# 支持平台
+
+- [x] 网页端
+- [ ] PC端
+- [ ] 小程序
+- [ ] 安卓端
+- [ ] iOS端
+
+------------
+
+## 说明 - Elucidation <!-- {docsify-ignore} -->
+
+限于精力和能力有限，目前暂时只有网页版，无小程序端、安卓端、iOS端、PC端。后续如果项目使用的人数较多，将会按照小程序端→PC端/安卓端→iOS端的顺序依次开发，如果项目使用的人不多，将不会考虑这些平台。但是待应用中心上线后，