- Table of Contents
- Introduction
- Installing and Running MDVista
- Setting MDVista as the Default App
- Reporting Bugs
- Contributing
- License
MDVista is a lightweight markdown viewer for Windows that helps users read .md and .markdown files without the extra hassle.
MDVista was created with the goal of offering a lightweight and easy-to-use markdown file viewer for daily reading. Whether you want to read simple notes or refer to complex technical documentation, MDVista allows you to do so without any cumbersome tools or converters.
MDVista is open source, which means it is free to download, use, and distribute under the GNU license.
- Windows 10 (build number 19041) or newer.
- Download the latest release zipped file from the releases page.
- Unpack the .zip file into a suitable location on your drive.
- Run the mdvista-[version]-setup.exe file from the unpacked folder to install MDVista.
- A small installer window will open and run for a few seconds and then close after the installation is completed.
- That's it! MDVista should now be installed and accessible via the programs list or start menu.
- HINT: You can open MDVista directly from a .md or .markdown file as well. Give it a try!
If you'd like to make MDVista the default app for markdown files you can do so quite easily. To get started, first locate a markdown file you want to run through MDVista.
Right click your markdown file and choose Open with > Choose another app
From the window that pops up locate MDVista in the list of apps. Select it and choose Always at the bottom.
Now MDVista should be the default app for markdown files. You may need to do the same with .markdown files if you did this for .md files, and vice versa.
First, open the Settings app from the start menu or by search.
Next, on the left hand widget, choose Apps > Default Apps.
Then under Set a default for a file type or link type, enter the file type (.md, .markdown) you want to assign MDVista to.
After entering the file type, you can click the file type listed below and choose MDVista from the list of options.
If you don't see MDVista on the list you can select Choose an app on your PC at the bottom of the list, to locate the install location of MDVista.
If you encounter a bug, error, or issue with MDVista, please consider creating an issues post. Doing so helps us make MDVista as great as possible for the community.
As always, please follow normal etiquette for posting bugs and issues, including:
- Informative heading and description detailing the exact problem that is occuring.
- Your system information including OS, OS version, and anything else you think might be helpful.
- Use clean and straightforward language to help others understand the issue. Some recommend roleplaying as a robot reporting a bug found in the system.
This project is happy to accept contributions from our community and fellow developers.
Please keep in mind, we highly advise that you first read our Contribution Guidelines and Developer Documentation before you begin working on a feature or bugfix. Here, you can gain valuable information on the inner workings of { app_name } and current features/fixes that are being focused on.
This step is crucial and helps to ensure that everyone stays on the same page and that there is no wasted effort on your part. Lastly, we would like to thank all of our contributers and graciouslly offer you a digital hug!
This project is licensed under the GNU license.