{"repo":"DavidWells/markdown-magic","free":true,"listed":false,"github":"https://github.com/DavidWells/markdown-magic","clone":"git clone https://github.com/DavidWells/markdown-magic.git","description":"💫 Automatically format markdown files via comment blocks using source code, external data & custom transforms.","language":"JavaScript","stars":866,"topics":["markdown","readme","docs","docs-generator","dx","wired"],"license":null,"category":"productivity","readme_excerpt":"Markdown Magic [![npm-version][npm-badge]][npm-link] ✨ Add a little magic to your markdown! ✨ About Markdown magic uses comment blocks in markdown files to automatically sync or transform its contents. - Automatically keep markdown files up to date from local or remote code sources - Transform markdown content with custom transform functions - Render markdown with any template engine - Automatically generate a table of contents - ... etc The comments markdown magic uses are hidden in markdown and when viewed as HTML. This README.md is generated with markdown-magic view the raw file to see how. Video demo • Example Repo Table of Contents Click to expand - About - Install - Usage - Running via CLI - Running programmatically - Syntax Examples - Basic - Curly braces - Square brackets - Parentheses - Functions - API - MarkdownMagicOptions - OutputConfig - MarkdownMagicResult - Transforms - TOC - CODE - FILE - REMOTE - fileTree - install - Inline transforms - Plugins - Legacy v1 & v2 plugins - Adding Custom Transforms - Plugin Example - Other usage examples - Custom Transform Demo - Usage examples - Misc Markdown helpers - Prior Art - License Install Via npm Via binary (no Node.js required) Download the prebuilt binary for your platform from GitHub Releases: Usage Use comment blocks in your markdown Example: Then run markdown-magic via it's CLI or programmatically. Running via CLI Run markdown --help to see all available CLI options CLI usage example with options In NPM scripts, np","default_branch":null,"files":null,"tree":[],"storefront":"/r/DavidWells","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/DavidWells/markdown-magic/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}