Installer mdsh avec Homebrew

Liens du projet

• Page d'accueil
• Dépôt

Commandes et alias

• mdsh

Historique du projet

The public repository was created on 2019-02-15. Its README explains the original problem as keeping README snippets, command output, and embedded file contents synchronized without manually copying text.

Unlike many preprocessors that emit a separate generated file, mdsh is designed around idempotent in-place updates. The README and project site document a compact Markdown extension for command blocks, comments, links, raw Markdown output, code-block output, and shell variable expansion.

Historique d'adoption

Official installation instructions recommend `cargo install mdsh`, Nix installation, Nix flakes, and use as a pre-commit hook. The input package-manager facts list Homebrew, dnf, and Nix packages.

GitHub metadata showed ongoing maintenance through 2026 and a modest but real open-source footprint, with repository topics around Markdown, pre-processing, and shell.

Modes d'utilisation

By default, `mdsh` processes `./README.md`; `--inputs`, `--output`, and `--work-dir` let users choose files and execution directories. The `--frozen` mode is intended for CI checks that fail when generated documentation is stale.

The README documents commands for reading files, executing shell commands, producing raw Markdown or code blocks, expanding environment variables, cleaning generated blocks, and installing mdsh as a pre-commit hook.

Pourquoi les passionnés de paquets s'y intéressent

mdsh matters to package-oriented developers because it turns a README into a reproducible build artifact without leaving Markdown. It is small, scriptable, CI-friendly, and sits in the same culture as literate shell docs, generated examples, and pre-commit-enforced documentation freshness.

Chronologie

• 2019: Public GitHub repository created.
• 2019: README license block identifies copyright for zimbatm and contributors.
• 2026: Repository metadata showed continued updates and availability through Cargo, Nix, Homebrew, and dnf-related packaging facts.

Related projects

• The README compares mdsh with literate programming, Jupyter Notebooks, active code/Pandoc filters, and Enola.dev ExecMD.
• The project deliberately chooses in-place Markdown updates rather than a separate rendered-document pipeline.

Sources

• https://api.github.com/repos/zimbatm/mdsh
• https://github.com/zimbatm/mdsh#readme
• https://zimbatm.github.io/mdsh/
• source_facts.package-manager