From 70ac0654c46cff8729d7eecea8934369c5bb1ee2 Mon Sep 17 00:00:00 2001 From: YuCheng Hu Date: Sun, 4 Jun 2023 17:00:45 -0400 Subject: [PATCH] =?UTF-8?q?=E8=B7=9F=E6=96=B0=E6=96=87=E6=A1=A3=E7=9A=84?= =?UTF-8?q?=E8=BF=90=E8=A1=8C=E6=96=B9=E5=BC=8F=E4=BB=8B=E7=BB=8D=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .idea/thriftCompiler.xml | 6 ------ CONTACT.md | 2 -- README.md | 28 ++++++++++++++++++++++++++-- cwikius-docs.iml | 2 +- 4 files changed, 27 insertions(+), 11 deletions(-) delete mode 100644 .idea/thriftCompiler.xml diff --git a/.idea/thriftCompiler.xml b/.idea/thriftCompiler.xml deleted file mode 100644 index 7bc123c..0000000 --- a/.idea/thriftCompiler.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/CONTACT.md b/CONTACT.md index 4d57f30..3e05c61 100644 --- a/CONTACT.md +++ b/CONTACT.md @@ -35,5 +35,3 @@ | WIKI 维基 | [www.cwiki.us](https://www.cwiki.us/) | 使用 Confluence 部署的 WIKI 知识库 | | DOCS.OSSEZ.COM | [https://docs.ossez.com/#/](https://docs.ossez.com/#/) | 本手册的编译版本将会部署在这个链接上 | | CN 博客 | [http://www.cwikius.cn/](http://www.cwikius.cn/) | CWIKIUS.CN 一个有独立思考和温度的清新站 | - -## \ No newline at end of file diff --git a/README.md b/README.md index 2159f58..5b7343d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ # CWIKIUS 文档和手册 -欢迎来到 CWIKIUS 文档和手册的空间 +欢迎来到 HoneyMoose 文档和手册的空间 -GitHub 上有关 CWIKIUS 的项目:[https://github.com/cwiki-us-docs/cwikius-docs](https://github.com/cwiki-us-docs/cwikius-docs) +GitHub 上有关 HoneyMoose 的项目:[https://github.com/honeymoose/cwikius-docs](https://github.com/honeymoose/cwikius-docs) [联系我们](CONTACT.md ':include') +## 如何运行文档 +本文档是通过 docsify 进行编译和安装的。 + +### 安装 docsify +如果你的计算机还没有安装 docsify 的话,请运行命令 `npm i docsify-cli -g` 来进行安装。 + +### 校验安装结果 +运行命令 `docsify -version` 来校验安装结果,界面上应该显示: + +```text +docsify-cli version: + 4.4.3 +``` + +### 运行 docsify +如果你希望在你的本地计算机上查看本文档,请运行 `docsify serve ./` , 在你的控制台上将会有下面的内如输出: + +```text +PS C:\WorkDir\Repository\Cwikius-Docs\cwikius-docs> docsify serve ./ + +Serving C:\WorkDir\Repository\Cwikius-Docs\cwikius-docs now. +Listening at http://localhost:3000 +``` + ## CWIKIUS 文档和手册快速导航 在下面的表格中,我们列出了一些比较有用的 CWIKIUS 相关软件开发使用教程的导航,在我们文档的整理中,也参考了一些这些文档。 diff --git a/cwikius-docs.iml b/cwikius-docs.iml index ad3c0a3..8021953 100644 --- a/cwikius-docs.iml +++ b/cwikius-docs.iml @@ -1,5 +1,5 @@ - +