This article details how to create multi-langugage instructional material in a variety of formats, including text, PDF, Markdown or even full HTML. These instructions will be presented side-by-side with your hands-on lab environment.

Your instructions should be in a file named one of the following:

  • README.txt = text format

  • README.pdf = pdf format

  • README.html = html format

  • README.md = markdown format

The README file should be created or uploaded to the $ASNLIB/public/docs directory. If more than one README file is in the directory, the file named higher in the above list will be displayed and the other(s) will be ignored.

With the HTML and Markdown format, you may embed external content (e.g., hyperlinks, Youtube videos); you may also use relative paths to reference other files including videos and images in the $ASNLIB/public/docs directory hierarchy.

For example, you may upload your own video to $ASNLIB/public/docs/myvideo.mp4, then reference it with:

<iframe width="560" height="315" src="./myvideo.mp4"></iframe>

Multi-Language

If you are preparing instructions in multiple languages, please create a directory structure as follows:

$ASNLIB/public/docs/lang/[language]/README.[filetype]

NOTE: the following Lab Types are not supported at this time: Basic, RStudio and Jupyter. If this is important to you, please let us know - support@vocareum.com

Examples

Here are some examples of the student experience:

  1. README.html with embedded video

2. README.md in a container lab

3. README.md in a cloud lab (AWS console launches in a new browser tab)

4. Multi-language README instructions

5. Full embedded HTML website with images, tabs, links, etc.

Did this answer your question?