{"id":11981,"date":"2021-01-08T23:00:18","date_gmt":"2021-01-09T04:00:18","guid":{"rendered":"https:\/\/blogs.mathworks.com\/pick\/?p=11981"},"modified":"2021-01-13T10:52:47","modified_gmt":"2021-01-13T15:52:47","slug":"convert-your-live-scripts-to-markdown-file","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/pick\/2021\/01\/08\/convert-your-live-scripts-to-markdown-file\/","title":{"rendered":"Convert your live scripts to markdown file"},"content":{"rendered":"
Jiro<\/span><\/a>'s Pick this week is <\/span>Live Script-to-Markdown<\/span><\/a> by <\/span>Michio<\/span><\/a>, one of my colleagues in MathWorks Japan.<\/span><\/div>
As you know, File Exchange allows you to have your files hosted on GitHub. Suppose you wrote a nice README documentation, with examples, using a live script. Unfortunately, GitHub does not render and display your live script. You would need to rewrite your readme file as a markdown file.<\/span><\/div>
Now, you won't have to rewrite your live scripts. Just use Michio's livescript-to-markdown entry. To be exact, it's actually <\/span>latex2markdown<\/span>, but live scripts can be easily exported to LaTeX so that's trivial.<\/span><\/div>
It takes care of all (?) possible formating and components that can be included in a live script, including code, figure outputs, equations, lists, images, etc. Compare for yourself the readme file Michio created for his own entry: <\/span>Live Script version<\/span><\/a>, <\/span>Markdown version<\/span><\/a>.<\/span><\/div>
Here's a snippet of the side-by-side comparison.<\/span><\/div>
\"mlx_md_comparison.png\"<\/img><\/div>
As he says at the end of the readme file, I \"hope it accelerates your MATLAB life!\"<\/span><\/div>
Give it a try and let us know what you think <\/span>here<\/span><\/a> or leave a <\/span>comment<\/span><\/a> for Michio.<\/span><\/div><\/div>