Folder Notice (README)

If you create a README.md file in a folder, its content is automatically displayed below the file list every time the folder is opened. You can use it to communicate folder usage rules or project guidance to team members. Attaching a notice to each folder lets every folder serve as its own guidance page, without a separate internal wiki.

Before You Start

• Administrator setting: README.md instant display must be turned on under Service Configuration > File Area for the README to be shown automatically when a folder is opened.

Uploading a README.md File

Create or upload a README.md file inside the folder. Write file naming conventions, folder guidance, project progress, and similar content in Markdown format.

Creating a Draft from the Folder Structure

If writing from scratch feels tedious, you can generate a draft by automatically outputting the folder structure and file list.

Click the Organize Folder button at the top of the folder, then click the Create File button in the Create README tab.

The current folder's structure and file list are output in Markdown. You can use this content as a README draft.

Viewing the Content

When you open the folder, the content of README.md is automatically shown below the file list.

Good to Know

• Only one README per folder is recognized
• Both uppercase and lowercase are recognized.

Related Documents

• File/Folder Comments
• Editing Text Files