CnapData 文档导入
  • 文档类型

    当前仅支持markdown格式的文档。

    heading类标题会被标记anchor，可实现页面内跳转
    支持table扩展语法
    支持tasklists扩展语法
  • 导入来源:
    • Git仓库
      需要仓库地址具有公开读权限以可被拉取
  • 版本生成：
    • 版本
      来自Gitee仓库时，会通过Gitee的Openapi拉取仓库tag作为文档版本使用。
    • 上传文件
      通过文件上传时，请勾选"包含版本"选型。
      文件解压后如果只有一个文件夹，则该文件夹的每个子文件夹包含一个版本的完整文档，文件夹名称即为版本号。
      如果解压后包含多个文件夹，则这些文件夹的名称即为版本号，文件夹中包含该版本的全部文档。
  • 文档名称
    如果文档内容第一个非空白行为markdown的header标记(即>=1个#)，则该header即为文档名称，并用作目录构建，否则使用文件名作为文档名称
  • 默认入口
    当页面访问进入文档的目录或子目录时，会尝试跳转到默认文档。
    默认文档的选择规则为扫描目录中文件，采用记分制，分数最高者被选择作为入口文档。
    • 文件名匹配readme时，+1
    • 文件名称匹配地区(如cn)时，+1
    • 文件名称匹配语言(如zh/en)时，+1