image thumbnail

MlxShake

version 0.3.0 (51.5 MB) by Andrew Janke
Export Matlab Live Scripts to Markdown

6 Downloads

Updated 15 Sep 2021

From GitHub

View license on GitHub

Janklab's MlxShake is a tool to export Matlab Live Scripts (.mlx files) to Markdown and other formats. It can export to Markdown, HTML, PDF, Microsoft Word, and more.
This tool lets you generate project documentation and web site content from live scripts in your project. This is a nice way of generating rich documentation with included graphics that are up to date with your latest code.
See the Tutorial at https://mlxshake.janklab.net/Tutorial.html for examples of what it can do. The Tutorial is itself generated from a Matlab live script using MlxShake!
EXAMPLE
Super quick examples:
janklab.mlxshake.exportlivescript('MyLiveScript.mlx')
From the shell or other programs:
./bin/mlxshake MyLiveScript.mlx --format html
The full documentation is available on the MlxShake web site at https://mlxshake.janklab.net.
ACKNOWLEDGMENTS
MlxShake is based on, and started out as a fork of, MathWorker Michio Inoue's livescript2markdown tool. MlxShake can largely be viewed as a productization of livescript2markdown.
The Live Script to LaTeX export code is informed by Pavel Roslovets's Live-Script-to-Markdown-Converter toolbox.
MlxShake adds the following enhancements over livescript2markdown:
  • Automate the full process from .mlx to .md.
  • Be suitable for use in automated document generation processes.
  • Make the Markdown good enough that no manual touch-up is usually needed.
  • Produce nicely-formatted output files.
  • Support additional output formats.
LICENSE WARNING
MlxShake is licensed under a nonstandard MathWorks-specific variant of the BSD 2-Clause License that includes this additional clause:
* In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings.
This is because the livescript2markdown project is licensed that way, and MlxShake contains derivatives of its code.

Cite As

Andrew Janke (2021). MlxShake (https://github.com/janklab/MlxShake/releases/tag/v0.3.0), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2019b
Compatible with R2019b and later releases
Platform Compatibility
Windows macOS Linux

Community Treasure Hunt

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

Start Hunting!

Mcode/+janklab/+mlxshake

Mcode/+janklab/+mlxshake/+internal

Mcode/+janklab/+mlxshake/+internal/+logger

Mcode/+janklab/+mlxshake/+internal/+logger/+internal

Mcode/+janklab/+mlxshake/+internal/+logger/+internal/private

Mcode/+janklab/+mlxshake/+internal/+logger/private

Mcode/+janklab/+mlxshake/+internal/+util

Mcode/+janklab/+mlxshake/+internal/+util/private

Mcode/+janklab/+mlxshake/+internal/private

Mcode/+janklab/+mlxshake/+test

Mcode/+janklab/+mlxshake/private

build/Mcode/+janklab/+mlxshake

build/Mcode/+janklab/+mlxshake/+internal

build/Mcode/+janklab/+mlxshake/+internal/+logger

build/Mcode/+janklab/+mlxshake/+internal/+logger/+internal

build/Mcode/+janklab/+mlxshake/+internal/+logger/+internal/private

build/Mcode/+janklab/+mlxshake/+internal/+logger/private

build/Mcode/+janklab/+mlxshake/+internal/+util

build/Mcode/+janklab/+mlxshake/+internal/+util/private

build/Mcode/+janklab/+mlxshake/+internal/private

build/Mcode/+janklab/+mlxshake/+test

build/Mcode/+janklab/+mlxshake/private

dev-kit

dev-kit/private

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+logger

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+logger/+internal

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+logger/+internal/private

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+logger/private

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+util

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/+util/private

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+internal/private

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/+test

dist/MlxShake-0.3.0/Mcode/+janklab/+mlxshake/private

docs

docs/_site

build/M-doc/examples

build/M-doc/examples/broken

build/M-doc/examples/qiita

dist/MlxShake-0.3.0/doc/examples

dist/MlxShake-0.3.0/doc/examples/broken

dist/MlxShake-0.3.0/doc/examples/qiita

dist/MlxShake-0.3.0/examples

dist/MlxShake-0.3.0/examples/broken

dist/MlxShake-0.3.0/examples/qiita

doc/examples

doc/examples/broken

doc/examples/qiita

docs-src

docs/_site/examples

docs/_site/examples/broken

docs/_site/examples/qiita

docs/examples

docs/examples/broken

docs/examples/qiita

examples

examples/broken

examples/qiita

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.