The Markdown Module: Rich Documentation for Your Labs

Every great remote lab needs clear instructions. Students need to understand what they’re doing, why they’re doing it, and how to interpret their results. The Markdown-it Module transforms simple text into rich, interactive documentation that makes your labs easier to follow and more engaging.

The Markdown-it Module brings powerful documentation capabilities to your Edrys-Lite labs. Write your lab instructions, explanations, and educational content in simple Markdown, and the module renders it beautifully with support for mathematical formulas, diagrams, embedded videos, and more.

It’s like having a textbook, whiteboard, and presentation slides all in one - right next to your interactive lab components.

Great labs aren’t just about tools - they need context. The Markdown-it Module helps you provide:

While standard Markdown is already powerful, the Markdown-it Module goes further with specialized support for educational content:

Need to explain an algorithm or physical law? Write formulas using standard mathematical notation with KaTeX support. From simple inline equations to complex multi-line derivations, mathematical content renders beautifully and clearly.

Create professional diagrams without leaving your text editor:

These tools let you illustrate concepts visually without needing separate diagramming software or image editing tools.

Embed YouTube videos, images, or even interactive HTML content directly in your documentation. Students get a complete learning experience without leaving the lab environment.

Different users might need different information. The Markdown-it Module lets you customize content for different roles:

Everyone gets exactly the information they need, presented clearly and consistently.

The Markdown-it Module shines when building complete learning experiences:

Add rich documentation to your Edrys-Lite lab by including this URL:

https://edrys-labs.github.io/module-markdown-it/index.html

Then write your content in Markdown. The module handles all the rendering, diagram generation, and formula display automatically. What you write is what your students see - beautifully formatted and ready to learn from.

When combined with the Editor Module, Terminal Module, and Streaming Module, the Markdown-it Module provides the educational context that makes remote labs truly effective.

Students don’t just use tools - they understand what they’re doing and why it matters.

The Markdown-it Module is open source and ready to transform your lab instructions into engaging learning materials.

Explore the module on GitHub: edrys-labs/module-markdown-it

Ready to create documentation that actually helps students learn? Add the Markdown-it module and watch your lab instructions come to life!