search

star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
https://www.showdoc.com.cn
Other
12.24k stars 2.19k forks source link

文件导出markdown格式时，文件名称非创建的文件名称问题 #2202

Open chynn0529 opened 5 months ago

chynn0529 commented 5 months ago

导出文件时选择markdown格式进行导出，查看导出的压缩文件发现，导出的md文件名非创建时的文件名称。

分析： 当前策略：假设文件名称为fileName，导出时fileName使用md5串代替，然后在另一个文件中将fileName与md5串进行对应

建议：直接使用文件名称

修改建议：直接使用树形结构形式保存文件。 1、将同级目录下的文件夹名称唯一化 2、将同一目录下的文件名称唯一化 3、导出markdown文件时，遍历项目目录结构，点击导出时自动创建文件夹和进行对应的markdown文件写入

star7th commented 5 months ago

命名的问题在不同服务器上会存在兼容问题，不打算花太多精力去处理这事情。showdoc导出的压缩包主要是为了能重新导入showdoc（比如迁移服务器等），不考虑太多人为阅读的因素。

chynn0529 commented 5 months ago

【兼容问题】这个问题应该还好吧，做个判断不就可以了。像下面这种： if "linux" == sys.platform: 具体逻辑

事先读取服务器的类型然后分别进行逻辑处理。一般软件兼容性都会这样做，我看该软件支持了linux和window两种本地化部署

star7th commented 5 months ago

既然你觉得那么容易，要不尝试贡献下代码？都是开源的，你也可以贡献源码

star7th commented 5 months ago

事情没有你想的那么简单。但是可能你确实有好的实现方式，所以你可以尝试下

chynn0529 commented 5 months ago

【showdoc导出的压缩包】 当前策略可以的，

只不过有点不方便就是我写完markdown只能复制书写的内容或者修改文件名后放到我的项目中了。这个软件挺好用

star7th commented 5 months ago

你的使用场景有问题。在showdoc上写完markdown，根本不需要复制内容或者修改文件名后放到项目。

star7th commented 5 months ago

我不知道你是如何使用的，正常使用的showdoc用户不会有这个问题。

chynn0529 commented 5 months ago

你的项目中除了代码，还需要写md文档说明。我想用showdoc写完内容 放到自己的md文件中，平时用vscode手敲md有点麻烦

star7th commented 5 months ago

这个不是showdoc的设定使用场景。你单纯只想编辑md文件的话可以用个本地编辑器。showdoc的场景就是showdoc上编辑，showdoc页面上查看。