Skip to main content

Convert a course to Markdown

Turns an Articulate Storyline .story file into a single Markdown document. Useful for review, diffing, search, or feeding a course into a documentation pipeline.

The short version​

oaf convert my-course.story

Markdown is the default format, so this writes my-course.md beside the input.

Choosing how much detail​

--mode controls how much of the course reaches the page.

ModeOutput
full (default)Every slide, with all content
summaryCondensed, structure plus key content
outlineHeadings only
oaf convert my-course.story --mode outline

Start with outline when you want to see a course's shape before committing to a full extraction.

Choosing what to include​

Four things are included by default and can each be switched off:

oaf convert my-course.story \
--no-notes \
--no-quizzes \
--no-media
FlagRemoves
--no-notesSpeaker notes
--no-quizzesQuiz questions and answers
--no-mediaImage, video, and audio references
--no-frontmatterThe YAML frontmatter block
--no-tocThe table of contents

Controlling how things render​

Quizzes and notes each have a format choice.

oaf convert my-course.story --quiz-format table --notes-format callout
OptionValuesDefault
--quiz-formatchecklist, table, detailschecklist
--notes-formatblockquote, callout, sectionblockquote

--quiz-format details wraps each question in a collapsible <details> block, which suits a document meant to be read without the answers showing. --notes-format callout emits admonition syntax, which is what you want if the Markdown is headed into a docs site that renders them.

Taking the media with you​

By default media is referenced, not extracted. The Markdown will point at files that do not exist next to it.

To pull the actual assets out of the .story package:

oaf convert my-course.story --copy-media ./assets

This writes every image, video, and audio file into ./assets.

A realistic invocation​

A course being prepared for review, as an outline, with answers hidden and assets extracted:

oaf convert my-course.story review.md \
--mode summary \
--quiz-format details \
--notes-format section \
--copy-media ./review-assets

Read the warnings​

Markdown cannot represent triggers, layer visibility, or branching. When the converter meets those it warns and carries on:

⚠ Conversion completed with warnings
⚠ Unsupported object type: drag-drop-panel on slide-014

If the interactive behavior matters, convert to oaf instead — the package retains what Markdown drops. See format support.