MarkdownPanel

Control which displays markdown as HTML within a MATLAB control
254 Downloads
Updated 25 Jun 2024

MATLAB FEX Minimum Version

MarkdownPanel

Control which displays markdown as HTML within a MATLAB control


This control utilizes the Showdown javascript library to convert markdown into HTML and then uses MATLAB's own uihtml component to display the resulting HTML.

It behaves like any other graphics object within MATLAB in that all properties can either be set upon object construction

h = MarkdownPanel('Parent', uifigure(), 'Content', '# Hello World!');

Or after object creation using the returned handle

h = MarkdownPanel();
h.Parent = uifigure();
set(h, 'Position', [0, 0, 0.5, 0.5])

To set the actual Markdown content, use the Content property. You can provide either a string, or a cell array of strings which will automatically create a multi-line entry

set(h, 'Content', '#Hello World')
set(h, 'Content', {'#Hello World', 'This is a test...'})

You can use the Options property to modify options that are specific to how Showdown renders the markdown. By default, we use all of the default settings except that we enable support for tables.

h.Options.tables = true;

The Options property is simply a struct where the fieldnames are the option names and the value is the option value. You can modify this struct to adjust an option.

% Enable support for tasklists
h.Options.taskslists = true

A complete list of options can be found in the Showdown documentation


Usage

panel = MarkdownPanel();

Outputs

panel, Graphics Object, The graphics handle that can be used to manipulate the appearance of the control


Demo

A demo application has been bundled with this code to show how to use some of the features. To run this demo, simply type the following into the MATLAB console.

MarkdownPanel.demo()

Markdown Demo Application


Attribution

Copyright (c) <2024> Jonathan Suever.
All rights reserved

This software is licensed under the BSD license

Cite As

Jonathan Suever (2024). MarkdownPanel (https://github.com/suever/MarkdownPanel/releases/tag/v2.2.0), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2024a
Compatible with R2019b and later releases
Platform Compatibility
Windows macOS Linux
Categories
Find more on Toolbox Distribution in Help Center and MATLAB Answers
Tags Add Tags

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Versions that use the GitHub default branch cannot be downloaded

Version Published Release Notes
2.2.0

See release notes for this release on GitHub: https://github.com/suever/MarkdownPanel/releases/tag/v2.2.0

2.1.0

See release notes for this release on GitHub: https://github.com/suever/MarkdownPanel/releases/tag/v2.1.0

2.0.0

* Updated to work on MATLAB R2021+
* Utilizes uihtml which requires a uifigure
* Updates Showdown JS to v2.1.0

1.0.0.0

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.