Including files

You can include various types of files in your texts. Depending on the type of files, they are shown in different ways. You must attach them to the assignment. To include an attached pdf document with label readme, you can write:

label: readme

This is built up as follows: 

  • The first line consists of three backquotes, followed by the word file. This indicates that you want to view a file
  • Next there is the label of a file that is attached to the assignment.
  • This can be followed by some options (see below).
  • And the block is ended by three backquotes.

Note that you cannot use this construction to view files that are stored somewhere else on the web. In this case, use an iframe to show external content.


The following options exist:

File types

The following file types are supported:

  • pdf files. Many types of documents you can transfer to pdf and can then be shown this way.
  • image files, like svg, png, and jpg. You can normally better use the image include for this.
  • programming code, like JavaScript, Java, Python, etc. Rather than including the code directly in the text you can also add a file. We support files with the following extensions: .js, .java, .c, .h, .cpp, .hpp, .py, and .cs.
  • Markdown files, ending with .md. This can be used to put large pieces of text in a file rather than directly in the editor.
  • text files, like .txt and .log files. (Basically anything else is shown as text.)

More will be added in the future. If the file type is not supported an error will be shown.

Still need help? Contact Us Contact Us