Skip to content

Commit 39b0f9e

Browse files
committed
update and format document
1 parent 3cadfe0 commit 39b0f9e

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

zh_CN/安装部署/DSSUserGuide部署文档.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> 简介:帮助文档模块属于dss-user-guide模块下,用于提供dss项目相关资料。
44
5-
在使用dss-user-guide模块时需先部署dss项目服务,可参考dss部署相关文档,dss-user-guide文档同步功能采用定时任务没两小时同步一次,文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置,及解析文档内容。
5+
        在使用dss-user-guide模块时需先部署dss项目服务,可参考dss部署相关文档,dss-user-guide文档同步功能采用定时任务没两小时同步一次,文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置,及解析文档内容。
66

77

88

@@ -20,23 +20,27 @@ host.gitbook.path=/appcom/Install/ApacheInstall/gitbook_books
2020
target.gitbook.path=/appcom/Install/ApacheInstall
2121
#用于忽略解析km下到目录
2222
summary.ignore.model=km
23+
#知识库同步方式:gitbook database
24+
guide.sync.model=gitbook
2325
````
2426

25-
### 1.2 建议配置
27+
### 1.2 DSS1.1.0配置
2628

2729
````properties
2830
#gitbook
2931
#文档所存放的服务器ip地址
3032
target.ip.address=127.0.0.1
3133
#文档所在服务器路径(目录配置到summary.md文件所在目录即可,例:/xxx/test1/SUMMARY.md)
3234
host.gitbook.path=/xxx/test1
35+
#Dss1.1.0不支持gitbook方式同步,故采取database
36+
guide.sync.model=gitbook
3337
````
3438

3539

3640

3741
## 2、SUMMARY.md文件结构说明
3842

39-
SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
43+
        SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
4044

4145
**例:**
4246

@@ -94,7 +98,7 @@ km
9498

9599
## 3.文件图片说明及配置
96100

97-
由于部分文档会存在插图,md文件被user-guide模块解析后会将其内容存放到数据库中,图片存放到数据库的只是图片到路径,故在md文档中插入图片的时候需要存放文件到相对路径,然后通过nginx代理到服务器图片存放的文件夹即可。
101+
        由于部分文档会存在插图,md文件被user-guide模块解析后会将其内容存放到数据库中,图片存放到数据库的只是图片到路径,故在md文档中插入图片的时候需要存放文件到相对路径,然后通过nginx代理到服务器图片存放的文件夹即可。
98102

99103
文件目录结构如下:(假设文件存放子服务器/xxx/test1目录下)
100104

@@ -123,7 +127,7 @@ location /images {
123127

124128
**注:这段配置需加在dss服务所在到nginx配置中,需要保证图片到ip:port有服务器一致。**
125129

126-
配置完成之后重启服务即可将文件同步到user-guide中!
130+
        配置完成之后重启服务即可将文件同步到user-guide中!
127131

128132

129133

0 commit comments

Comments
 (0)