https://github.com/suever/markdownpanel

Panel for displaying Markdown as HTML within a MATLAB GUI
https://github.com/suever/markdownpanel

Last synced: 23 days ago
JSON representation

Panel for displaying Markdown as HTML within a MATLAB GUI

• Host: GitHub
• URL: https://github.com/suever/markdownpanel
• Owner: suever
• License: other
• Created: 2016-03-02T21:46:55.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T01:14:46.000Z (4 months ago)
• Last Synced: 2024-06-26T04:52:51.234Z (4 months ago)
• Language: MATLAB
• Homepage:
• Size: 214 KB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![MATLAB FEX](https://img.shields.io/badge/MATLAB%20FEX-60536-green.svg)][fex]

[![Minimum Version](https://img.shields.io/badge/Requires-R2014a-blue.svg)][matlab]

# MarkdownPanel

Control which displays markdown as HTML within a MATLAB control

 

------

This control utilizes the [Showdown javascript library][1] 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][1]

 

------

**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][4]

 

------

**Attribution**

 

Copyright (c) <2024> [Jonathan Suever][2].  

All rights reserved

 

This software is licensed under the [BSD license][3]

 

[1]: https://github.com/showdownjs/showdown

[2]: https://github.com/suever

[3]: https://github.com/suever/MarkdownPanel/blob/main/LICENSE

[4]: https://cdn.rawgit.com/suever/MarkdownPanel/main/MarkdownPanel.png

[fex]: https://www.mathworks.com/matlabcentral/fileexchange/60536-markdownpanel

[matlab]: http://www.mathworks.com/products/matlab/