CloudShare allows you to quickly create Guided Journeys by importing content directly from a Markdown (.md) file. This feature is ideal for when you already have training materials and want to bring that content into CloudShare for interactive, structured learning experiences.
Using Markdown to create your Guided Journey helps you:
- Save time by reusing existing docs.
- Preserve formatting and hierarchy.
- Maintain consistency across training experiences.
CloudShare supports the following Markdown types to ensure compatibility with commonly-used formats:
-
Markdown 1.0 (100%)
Full support for the original Markdown syntax, ensuring complete compatibility. -
CommonMark 0.31 (96%)
Nearly complete support for the CommonMark specification, offering a robust and standardized parsing experience. -
GitHub Flavored Markdown 0.29 (95%)
High-level support for GitHub Flavored Markdown, incorporating GitHub-specific extensions while maintaining compatibility with core Markdown syntax.
By supporting these widely used types, CloudShare ensures a seamless experience with the most common Markdown formats.
To create a Guided Journey using Markdown:
- In the Editor, click + Content Item, and then select Guided Journey.
- Choose Import content from a Markdown file.
- In the Choose Content Hierarchy area, you can choose how to organize the content into chapters and sections within your Guided Journey. CloudShare uses a two-level hierarchy, where each Guided Journey is structured around high-level chapters that contain one or more sections. Your selection here determines how the content will be broken down and displayed to participants, allowing for a clear and navigable learning experience.
Option 1: CloudShare Logic
CloudShare Logic offers a fast, consistent way to structure your Guided Journey, by automatically organizing your Markdown content into chapters and sections based on its existing hierarchy. This parsing saves time and eliminates the need for manual setup. This choice is ideal for cleanly-structured Markdown files with standard heading usage.
CloudShare Logic scans the headers in your Markdown file and uses the structure to determine how to build the Guided Journey. The logic follows these rules:
Section Naming
Section names are created by combining the names of nested headers above them (excluding the chapter name). This helps reflect the content hierarchy and provides clarity in navigation.
Estimated Time
Each section is automatically given a default estimated time of 10 minutes. You can update this value as needed.
Note: Markdown best practice recommends starting with a # (H1) heading as the main title, followed by ##, ###, etc. for sub-sections - to establish a clear content hierarchy. The CloudShare Logic relies on this convention and specifically requires the presence of a # heading as the highest-level element in uploaded Markdown (.md) files. If the # heading is missing, the system cannot correctly parse or process the content. Proper adherence to this structure ensures consistent and reliable behavior across all experiences using CloudShare Logic.
If you prefer to define chapters and sections manually using Markdown tags, see the Custom Logic option below.
Option 2: Custom Logic
By choosing this option, your content will be organized into chapters and sections based on your customized logic. This gives you full control over how your Guided Journey is structured. To enable this, you’ll need to add specific tags in your Markdown file to help CloudShare identify which parts of the content represent chapters and which represent sections.
Use the following syntax:
[comment]: <> (Guided_Journey_Chapter) for chapters, and
[comment]: <> (Guided_Journey_Section) for sections.
These tags will need to be set up in chronological order. The chapter tag should be first, and then the section tags should be under that tag for that chapter.
This approach allows for greater flexibility, especially when your content does not follow a strict hierarchical structure.
Ensure that:content appears after the section tag, and that all tags are correctly placed to reflect your intended flow.
- Upload your files in the Upload Files area.
You should upload the following files:
- Markdown (.md) file – The main content file (maximum size is 30 MB).
- Media files – The media files you use on your selected markdown file. This can include any media supported by CloudShare, with a total size limit of 150 MB. All associated media files must be provided together with the markdown content. Supported file types are .jpg, .jpeg, .png, .gif, and .svg.
Note: All media files must be named exactly as referenced in the Markdown file, including case sensitivity. For example: .
- Once you have completed the steps above, click Import, and your Guided Journey will be created based on the files and logic you provided. After the import, you can preview your Guided Journey to ensure that everything is in place.
If needed, you can make quick edits before saving, ensuring that your content is aligned with your intended structure.