Skillable Studio allows you to manage Lab Instructions from outside of Skillable Studio, using a Markdown Include, instead of a direct connection to an external repository. Choosing to leverage this feature means moving all of your content management (including editing) for a lab into a source of your choosing, outside of Skillable Studio. Once you add the Markdown Include syntax to a lab's instructions, the content in that lab will automatically be updated based on the content in the external source. The Markdown file must be stored in a publicly accessible location and must contain only Markdown syntax.
External Management Benefits
Offline editing - With external instruction management, content is created or edited as part of a structured Markdown file, that can be edited offline using one of the many free or commercial Markdown editors that are available for all mainstream platforms/devices being used today, including Windows, macOS, Linux, iOS, and Android.
Multi-author support - By managing your content in a lab that leverages external instruction source, you can support multiple content authors contributing to the content for one lab at the same time.
External Management Disadvantages
Skillable Studio Custom Syntax Unavailable in External Repository - when using an external instruction source, custom Skillable Studio markdown syntax will not render in the external system. These markdown elements can still be used and will be rendered in a lab.
These include:Knowledge block/link
Alert block/link
Help block/link
Hint block/link
Note block
Copyable text
Type text
code block modifiers
@lab replacement tokens Intellisense
Best Practices
When using an external instruction source, there are a few things to consider.
We highly recommend using an instruction source dedicated to your lab content and not mixing other content within the source.
You are able to host content for multiple lab profiles from the same instruction source. A good rule of thumb would be one markdown source per Course or per Lab Series.
Getting started
Your instruction source will need a markdown (.md) file that defines the lab content in Markdown. This file will contain the lab instructions for your lab.
The Markdown file must only contain Markdown, and not any HTML, or any other syntax. If there is anything other than Markdown in the file, the lab instructions may not look correct.
Configuring a Lab Profile
To configure a Lab Profile to use instructions from an external source:
From a Lab Profile, select Edit Instructions.
Select an Instruction Set.
Enter the Markdown Include syntax:
!instructions[](url)Replace
urlwith the URL where your Markdown file is stored. For example,!instructions[](https://mylabcontent.com/lab1.md)
The Markdown content is now displayed in the Lab Instructions. Confirm the instructions are displayed correctly. If any adjustments need to be made to the lab instructions, adjustments must be made in the external source.
Skillable Studio supports adding content to the Lab Instructions alongside the content added by the Markdown Include, using Markdown or Skillable’s Visual Instruction Editor.
Activities
Automated and question activities can be used when using an external repository as an instruction source. Activities must be added to the Lab profile and then the Activity Replacement Token added to the lab instructions in the external repository.
To add an Activity to a Lab Profile that uses an external instruction source:
Navigate to the Lab profile.
Select Edit Instructions in the upper-right corner.
Select the Activities menu.
Select + New Question or + New Automated Activity.
After creating the Activity, copy the Token for the Activity.
Navigate to your external repository, and edit the file that is used for the lab instructions.
Paste the token in the file, where you want the Activity to be displayed.
The Activity is now part of your lab instructions. Repeat these steps to add additional Activities.