跳转到内容
搜索文档

文件规范

最后更新 查看 MarkdownAgent 设置

我们的文档在文件方面有一些规范。

命名

创建新文件时,命名应遵循特定的规范。

文件名应当:

  • 在语义上清晰表达文件的目的
  • 采用全小写
  • 单词之间使用连字符(-)
可接受的文件名txt
/src/content/docs/fundamentals/concepts/what-is-cloudflare.mdx
/src/assets/images/api-shield/api-shield-call-sequence.png
不可接受的文件名txt
/src/content/docs/fundamentals/concepts/What is Cloudflare.mdx
/src/content/docs/fundamentals/concepts/What-is-Cloudflare.mdx
/src/assets/images/api-shield/API_Image_1.png

这些规范对于用户可读性、SEO 规范以及确保我们的 GitHub 操作不中断非常重要。

文件夹

每个文件夹都应该包含一个名为 index.mdx 的文件。

/src/content/docs/fundamentals/concepts/index.mdx

/src/content/docs/fundamentals/concepts/index.mdx 处的内容将被渲染在 https://developers.cloudflare.com/fundamentals/concepts/

内容文件

将常规内容文件添加到 /src/content/docs/{product_folder}/ 目录中。

/src/content/docs/fundamentals/concepts/what-is-cloudflare.mdx

图像文件

将图像文件添加到 /src/assets/images/{product_folder}/ 目录中。

/src/assets/images/api-shield/api-shield-call-sequence.png

这篇文档对您有帮助吗?