跳转到正文

文件夹公告(README)

在文件夹里创建 README.md 文件后,每次打开文件夹时都会在文件列表下方自动显示其内容。可以用来向团队成员传达文件夹使用规则或项目说明。为每个文件夹附上说明后,即使没有单独的公司内部 Wiki,每个文件夹也能充当自己的说明页面。


开始之前

  • 管理员设置:需要在 服务配置 > 文件区域 中开启 立即显示 README.md,打开文件夹时才会自动显示 README。

上传 README.md 文件

在文件夹中创建或上传 README.md 文件。 以 Markdown 格式撰写文件命名规则、文件夹说明、项目进展情况等内容。

根据文件夹结构创建草稿

如果从头撰写比较麻烦,可以自动输出文件夹结构和文件列表来创建草稿。

点击文件夹上方的 整理文件夹 按钮,在 创建 README 选项卡中点击 创建文件 按钮。

文件夹中会创建一个包含当前文件夹的文件夹和文件列表的 README.md 文件。将此文件改写为 README 草稿即可。如果 README.md 已存在,可在 另存为 和 覆盖 中选择。

创建 README

查看内容

打开文件夹后,README.md 的内容会自动显示在文件列表下方。

README 显示示例

注意事项

  • 每个文件夹只识别一个 README
  • 大小写均可识别。

相关文档