LabVIEW Idea Exchange

cancel
Showing results for 
Search instead for 
Did you mean: 
Engineero713

Markdown support in free labels, descriptions, and documentation

Status: New

I would love to see Markdown support added to free labels and documentation in LabVIEW. I know that you can use HTML tags to add text formatting and now hyperlinks in 2015, but Markdown makes this much easier (in my opinion) to edit in the first place. For example, hyperlinks are specified in Markdown as [link text](URL), italic text is *between single asterisks*, and bold text is **between double asterisks** when editing. The raw Markdown text could be shown when editing, and then the resulting text with formatting shown when displayed.

 

For anyone unfamiliar with Markdown, you can find detailed syntax documentation here. It is licensed under a BSD-style open-source license. I am not affiliated in any way.

3 Comments
AristosQueue (NI)
NI Employee (retired)
Please take a look at this plug-in for LV 2015. It is HTML markup instead of markdown, but you could use it as a starting point if you have a markdown parser. I did not know markdown well enough to do the work. https://decibel.ni.com/content/docs/DOC-43622
JacobsCSD
Member

Based on Christina's blog post, it looks like the current implimentation for links in block diagram free labels is very close to a markdown syntax.  Instead of http://ni.com<National Instruments> the markdown syntax would be [National Instruments](http://ni.com) or [National Instruments][1] where the line 1: http://ni.com existed later in the document.  If NI was interested in supporting a more standard way of including rich text type formatting in a plain-text field, Markdown (or CommonMark) would be the most popular choice.  Markdown is used on GitHub and StackOverflow to name a few.  

 

Does the plugin you've posted allow someone to edit block diagram and front panel based labels?

AristosQueue (NI)
NI Employee (retired)
JacobsCSD: Yes.