How To: Format content descriptions with markdown

Using markdown

Markdown is a lightweight markup language with plain text formatting syntax, that you can use in content item and session descriptions to enhance their formatting. You can add much longer descriptions, and by using markdown, you can add headings to provide author information, use bullets to list objectives, and add hyperlinks to related resources. You can also add bold and italic text for additional emphasis.

The content and session item descriptions you enter by using the Catalogue area within the Agylia Administration portal are displayed on the content items' landing pages within both the Web learner portal and Apps. The descriptive text simply flows down the landing pages, enabling you to add as much descriptive text as you like.

The support for hyperlinks lets you reference related resources and web pages. Common examples include adding a Google Map reference, a hotel accommodation link for a classroom training session or an online meeting link generated by your virtual conferencing system.

Markdown syntax is simple to edit and you can use a preview window to quickly check your formatting to give you an approximation for how it will appear in your Web learner portal and Apps.

NOTE: We recommend that the first paragraph of any description does not use markdown or include line breaks. This will ensure a more consistent text layout on content tiles in the Web learner portal.

Examples of the markdown syntax you can use, and how the text will be displayed in the Web learner portal and Apps, are shown in the table below.

Markdown text you can enter	Appearance
Here is a bold word	Here is a bold word
Here is an italic word	Here is an italic word
Here is a bulleted list - one - two - three	Here is a bulleted list one two three
Here is a numbered list 1. one 2. two 3. three	Here is a numbered list one two three
# Level one heading	Level one heading
## Level two heading	Level two heading
### Level three heading	Level three heading
Here is a hyperlink to the [BBC web site](http://www.bbc.co.uk)	Here is a hyperlink to the BBC web site
[BBC web site - with alt text](http://www.bbc.co.uk "The BBC home page")	BBC Web site - with alt text The alt text will appear when the user hovers over the link. The alt text ("The BBC home page") is not supported on this support site but is suported byt he Agylia LMS.
[Agylia Support Team](mailto:support@agylia.com)	Agylia Support Team