Document your course

Outcome You add a README.md file to your course that students see automatically on the space overview, with links and embedded video.

Before you start

• You are an Instance Editor or Space Administrator.

• You are in the Current state of the Master Instance.

Any folder in Nuvolos can contain a README.md file that is rendered automatically as Markdown by the web UI. The top-level README.md in the Master Instance is also displayed on the space overview, making it the natural home for course-level documentation.

Edit a README from the web UI

1

Open the Files view of the Master Instance.

2

Locate the README.md file you want to edit (or create one with + NEW).

3

In the ... Actions menu on the file row, choose EDIT.

4

Use the WYSIWYG or source-code editor to write your content in Markdown.

5

Save your changes.

You can embed videos from streaming providers directly in the README by pasting the embed snippet they provide. This is useful for keeping a running log of recorded lectures that students can review.

For full Markdown features supported by Nuvolos - including links to headings via the Anchor button - see Reference › Storage and file access.