Add a Site Dashboard README

The Site Dashboard README file displays custom Markdown content on the Summary tab of your Site Dashboard, giving your team immediate access to project information.

You can add a README to your Site Dashboard from the Site Dashboard using Configuration Mode, or by creating the file directly in your Local Development Environment.

Add a README from the Site Dashboard#

To add a README using Configuration Mode:

1. Navigate to the Summary tab on your Site Dashboard.
2. Click the Configuration Mode switch on the right of the Site Header to turn it on.
3. Click the Add README button. CloudCannon will create a .cloudcannon/README.md file and open it in the Content Editor.
4. Add your content.

CloudCannon will automatically display your README content on the Summary tab of the Site Dashboard. When you are happy with your content, save your file back to your Git Repository.

Add a README from your IDE#

To add a README directly in your repository:

1. Create a file at .cloudcannon/README.md in your Git repository.
2. Add your Markdown content and commit the file Git Repository.

CloudCannon will automatically sync the changes to your Git Repository and display your README content on the Summary tab of the Site Dashboard.

Edit your README#

You can edit your README file in CloudCannon using the Content Editor. To open your README for in the Content Editor, turn on Configuration Mode and click the Edit README button on the Site Dashboard.

You can also edit the file directly in your IDE or through the File Browser in CloudCannon.