m2md
This utility aims to autogenerate markdown documentation for MATLAB code, that can easily be hosted on GitHub or GitLab pages. This is currently a pre-release, and contains two known bugs:
1. Multi-line function and classdef declarations (e.g., line broken with '...') will crash m2md
2. Documentation is not placed into the proper subfolders
These issues should be fixed by the end of the day, along with a new feature to generate index files.
Cite As
Chris Gnam (2024). m2md (https://github.com/crgnam-research/m2docs/releases/tag/1.9.1), GitHub. Retrieved .
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxTags
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
demo
src
src/templates
src/types
Version | Published | Release Notes | |
---|---|---|---|
1.9.1 | See release notes for this release on GitHub: https://github.com/crgnam-research/m2docs/releases/tag/1.9.1 |
||
1.0 | See release notes for this release on GitHub: https://github.com/crgnam-research/m2md/releases/tag/1.0 |
||
0.9.3 | See release notes for this release on GitHub: https://github.com/crgnam-research/m2md/releases/tag/0.9.3 |
||
0.9.2 | See release notes for this release on GitHub: https://github.com/crgnam-research/m2md/releases/tag/0.9.2 |
||
0.9.1 |