Markdown link syntax supported in SharePoint Learning Kit assignment descriptions

17 April, 2015 · less than a minute to read

Markdown link syntax supported in SharePoint Learning Kit assignment descriptions

Following on from enabling links in an assignment’s description in SLK, we had a request to turn urls to OneNote pages more readable. A typical link to a OneNote page is

https://tenancy.sharepoint.com/_layouts/15/WopiFrame.aspx?sourcedoc={e2ea84dc-5bef-4d1d-9788-35f30cc8f4c5}&action=edit&wd=target%28%2F%2FSLK.one%7C17b5d14c-d903-4a96-8137-904b2c1ddb22%2F1.8%7Cd72c4f32-9f99-4a5e-a4f0-286bab08b1e1%2F%29

which is really not very pretty. This links to a page 1.8, in section SLK in the Shared Notebook OneNote on SharePoint 2013.

To resolve this I’ve added support for manually adding a title for the link, to hide the link details from view. To use this I’ve used Markdown syntax which is of the form

[link text](url)

So

[Shared Notebook/SLK/1.8](https://tenancy.sharepoint.com/_layouts/15/WopiFrame.aspx?sourcedoc={e2ea84dc-5bef-4d1d-9788-35f30cc8f4c5}&action=edit&wd=target%28%2F%2FSLK.one%7C17b5d14c-d903-4a96-8137-904b2c1ddb22%2F1.8%7Cd72c4f32-9f99-4a5e-a4f0-286bab08b1e1%2F%29)

would be output as

Shared Notebook/SLK/1.8

which is much nicer in a description. The full Markdown link syntax also includes an optional title attribute

[link text[(url “title”)

this is not supported, and neither is any other Markdown syntax.

Standard urls not in Markdown syntax will display at before, so

Update this notebook [Shared Notebook/SLK/1.8](https://tenancy.sharepoint.com/_layouts/15/WopiFrame.aspx?sourcedoc={e2ea84dc-5bef-4d1d-9788-35f30cc8f4c5}&action=edit&wd=target%28%2F%2FSLK.one%7C17b5d14c-d903-4a96-8137-904b2c1ddb22%2F1.8%7Cd72c4f32-9f99-4a5e-a4f0-286bab08b1e1%2F%29)

and another link www.salamandersoft.co.uk 
www.microsoft.com.

Will display as

Update this notebook Shared Notebook/SLK/1.8
and another link www.salamandersoft.co.uk
www.microsoft.com.

Richard Willis headshot

Written by Richard Willis

Managing Director / Founder

Richard started SalamanderSoft in 2007 after a successful career as a software developer. Wanting to start his own company and with experience in integrating school systems he set out to build the best integration system for schools and to exceed customer expectations. He starting out on his own, doing all the coding, support and sales until finally the growing number of customers meant he needed to start growing the team. He is still heavily involved in coding the core Integration Suite product in addition to running the company and being the first point of contact for prospective customers.

Copyright © 2020 SalamanderSoft Limited