Skip to content

fcl 第三方文档

网站链接

添加文档

  1. 在'docs/<文档分类>'目录下创建 md 文件并写入文档内容。

    在 md 文件的底部部添加以下内容 编辑作者: [名称] (相关链接)
    QQ: QQ 号,可有可无
    邮箱: 邮箱
    创建时间: 年.月.日
    修改时间: 年.月.日

  2. 在'docs/img/'目录下创建目录'<创建的 md 文件名>'放你的图片资源。

  3. 在'docs/<文档分类>/<文档名>'放你的非图片资源,目前只接受小于等于 50mb 的文件。

  4. 在'.vitepress/config.mts'中添加你的文档。

  5. 运行命令'npm docs:dev'检查是否正常。(需要 nodejs 20.x 以上版本)

  6. 提交代码到 github,拉取请求。(请提前克隆好仓库)

修改文档

  1. 在'docs/<文档分类>'目录下找到对应的 md 文件。
  2. 修改文档内容。
  3. 修改页脚最后修改时间。
  4. 运行命令'npm docs:dev'检查是否正常。(需要 nodejs 20.x 以上版本)
  5. 提交代码到 github,拉取请求。(请提前克隆好仓库)

删除文档

  1. 在'docs/<文档分类>'目录下找到对应的 md 文件。
  2. 删除添加的资源。(如有)
  3. 在'.vitepress.config.mts'中删除你的文档。
  4. 提交代码到 github,拉取请求。(请提前克隆好仓库)