diff --git a/docs/user/files-and-folders/img/readme-files/readme-list-view.png b/docs/user/files-and-folders/img/readme-files/readme-list-view.png new file mode 100644 index 00000000..8c8adf46 Binary files /dev/null and b/docs/user/files-and-folders/img/readme-files/readme-list-view.png differ diff --git a/docs/user/files-and-folders/img/readme-files/readme-removed.png b/docs/user/files-and-folders/img/readme-files/readme-removed.png new file mode 100644 index 00000000..2876fd96 Binary files /dev/null and b/docs/user/files-and-folders/img/readme-files/readme-removed.png differ diff --git a/docs/user/files-and-folders/index.md b/docs/user/files-and-folders/index.md index 9c3d729b..968fcebc 100644 --- a/docs/user/files-and-folders/index.md +++ b/docs/user/files-and-folders/index.md @@ -22,6 +22,9 @@ This section covers common day-to-day tasks such as creating and moving content, - [Delete and restore items from the trash](./delete-restore.md) Remove files and folders and restore them later if needed. +- [README files in folders](./readme-files.md) + Add a `README.md` file to a folder so OpenCloud renders it above the file list. + ### Find and classify content - [Search for files and content](./search.md) diff --git a/docs/user/files-and-folders/readme-files.md b/docs/user/files-and-folders/readme-files.md new file mode 100644 index 00000000..2962d06f --- /dev/null +++ b/docs/user/files-and-folders/readme-files.md @@ -0,0 +1,52 @@ +--- +sidebar_position: 3.5 +title: README Files in Folders +description: Learn how README.md files are rendered in folders in OpenCloud. +--- + +# README Files in Folders + +If a folder contains a file named `README.md`, OpenCloud renders its Markdown content above the file list. + +README rendered in list view with the file still visible + +## Create a README File + +1. Open the folder where you want to add the README. +2. Create or upload a file named `README.md`. +3. Add your Markdown content and save the file. + +OpenCloud renders the content when the folder is opened or refreshed. + +## Supported File Name + +The file name must be exactly: + +```text +README.md +``` + +## Example + +A `README.md` file can contain Markdown like this: + +```markdown +# Photos + +This folder contains visual samples for preview and documentation screenshots. + +The images are used to show list view, thumbnail view, and image preview behavior in OpenCloud. + +## Files + +- moon-surface-public-domain.jpg +- rotated-chessboard-photo.jpg +- vintage-computer-terminal.jpg +- Space-Nebula.jpg +``` + +## Remove the README Section + +Delete or rename `README.md` to remove the rendered section. + +Folder without the rendered README section