← All tools

Votarymortiseandtenonjoint137/mdproof

Popularity 65 Updated Content & Media

Turn Markdown files into executable tests that verify commands and outputs for documentation, runbooks, and smoke testing.

githubauto-collected

Installation

A directly usable install command is not verified yet. Check the project documentation or releases.

🧪 mdproof - Turn Markdown Into Executable Tests

📋 What is mdproof?

mdproof helps you turn Markdown documents and runbooks into tests you can run on your computer. This means you can check that your documents work as expected without writing code. It makes sure your instructions, guides, and checks stay accurate over time.

You don’t need to know how to program. mdproof runs tests based on the steps you already wrote in Markdown. It works well for developers, writers, or teams who want to keep their documentation reliable.

🔎 Key Features

  • Converts your Markdown files into tests automatically
  • Runs tests that check technical runbooks or manuals
  • Supports different types of testing, like integration and smoke tests
  • No coding needed for test creation
  • Works with command-line on Windows
  • Helps keep documentation up to date and reliable

🛠️ System Requirements

To use mdproof on Windows, your computer needs:

  • Windows 10 or higher
  • Minimum 2 GB of free memory
  • At least 100 MB of free disk space
  • A stable internet connection for downloading
  • Command Prompt or PowerShell access

If you don’t have administrative rights, you can still install mdproof for your user account.

🚀 Getting Started

Follow these steps to get mdproof running on your Windows PC.

1. Visit the Download Page

Click this big button to go to the download page:

This page lists the available versions and files to download. Look for the latest stable release.

2. Download the Windows Installer or ZIP File

On the release page, find a file with .exe or .zip in the name. This is the installer or zipped program you will run. Click the file to download it to your PC.

  • If it’s an .exe file, you can run it directly.
  • If it’s a .zip file, right-click the file and choose "Extract All" to unzip it anywhere convenient like your Desktop.