MlxShake

版本 0.3.0 (49.9 MB) 作者: Andrew Janke
Export Matlab Live Scripts to Markdown
20.0 次下载
更新时间 2021/9/15
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.

引用格式

Andrew Janke (2024). MlxShake (https://github.com/janklab/MlxShake/releases/tag/v0.3.0), GitHub. 检索来源 .

MATLAB 版本兼容性
创建方式 R2019b
与 R2019b 及更高版本兼容
平台兼容性
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

dev-kit

dev-kit/private

docs

doc/examples

doc/examples/broken

doc/examples/qiita

docs-src

docs/examples

docs/examples/broken

docs/examples/qiita

examples

examples/broken

examples/qiita

版本 已发布 发行说明
0.3.0

See release notes for this release on GitHub: https://github.com/janklab/MlxShake/releases/tag/v0.3.0

0.2.1

0.2.0.0

See release notes for this release on GitHub: https://github.com/janklab/MlxShake/releases/tag/v0.2.0

要查看或报告此来自 GitHub 的附加功能中的问题,请访问其 GitHub 仓库
要查看或报告此来自 GitHub 的附加功能中的问题,请访问其 GitHub 仓库