跟新文档的运行方式介绍。

This commit is contained in:
YuCheng Hu 2023-06-04 17:00:45 -04:00
parent 0da2d8306c
commit 70ac0654c4
4 changed files with 27 additions and 11 deletions

View File

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ThriftCompiler">
<compilers />
</component>
</project>

View File

@ -35,5 +35,3 @@
| WIKI 维基 | [www.cwiki.us](https://www.cwiki.us/) | 使用 Confluence 部署的 WIKI 知识库 | | WIKI 维基 | [www.cwiki.us](https://www.cwiki.us/) | 使用 Confluence 部署的 WIKI 知识库 |
| DOCS.OSSEZ.COM | [https://docs.ossez.com/#/](https://docs.ossez.com/#/) | 本手册的编译版本将会部署在这个链接上 | | DOCS.OSSEZ.COM | [https://docs.ossez.com/#/](https://docs.ossez.com/#/) | 本手册的编译版本将会部署在这个链接上 |
| CN 博客 | [http://www.cwikius.cn/](http://www.cwikius.cn/) | CWIKIUS.CN 一个有独立思考和温度的清新站 | | CN 博客 | [http://www.cwikius.cn/](http://www.cwikius.cn/) | CWIKIUS.CN 一个有独立思考和温度的清新站 |
##

View File

@ -1,11 +1,35 @@
# CWIKIUS 文档和手册 # 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') [联系我们](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 文档和手册快速导航
在下面的表格中,我们列出了一些比较有用的 CWIKIUS 相关软件开发使用教程的导航,在我们文档的整理中,也参考了一些这些文档。 在下面的表格中,我们列出了一些比较有用的 CWIKIUS 相关软件开发使用教程的导航,在我们文档的整理中,也参考了一些这些文档。

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4"> <module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true"> <component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output /> <exclude-output />
<content url="file://$MODULE_DIR$" /> <content url="file://$MODULE_DIR$" />