CyberViewMD: Streamlined Markdown File Previewer

Description

CyberViewMD is a macOS application designed for previewing Markdown files. It provides an easy and efficient way to view your Markdown documents without the need for editing functionalities. Developed using the Electron framework, CyberViewMD aims to offer a streamlined user experience for developers, writers, and anyone who frequently works with Markdown files.

Why This Project Exists

The Markdown format is widely used for documentation, note-taking, and content creation, but the options for simply viewing these files can sometimes be limited or cluttered with editing features not everyone needs. CyberViewMD aims to fill this gap by providing a clean, focused interface solely for previewing Markdown files. Whether you're a developer who frequently references README files, a writer looking to quickly view your work, or any user in between, CyberViewMD offers a streamlined, distraction-free environment to view your Markdown documents.

Features

• Quick and responsive Markdown file preview
• Minimalist design with clean and distraction-free UI for easy-to-use
• Support for various Markdown elements like headers, lists, tables, etc.
• Automatically removes Front-Matter for a focused viewing experience
• Drag-and-drop file opening
• Keyboard shortcuts for ease of use

Installation

1. Download the latest release from the GitHub repository.
2. Unzip the downloaded file.
3. Drag and drop CyberViewMD.app into your Applications folder.

or:

1. Clone this repository.

   git clone https://github.com/ArthurGareginyan/cyberviewmd.git

2. Navigate to the project directory.

   cd cyberviewmd

3. Install dependencies.

   npm install

4. Run the application.

   npm start

How to Use

1. Open the CyberViewMD application or start the application from the terminal.
2. Drag and drop a Markdown file into the application window or use the File > Open menu.
3. The Markdown file will be automatically rendered and displayed.

Keyboard Shortcuts

• Cmd + O: Open file
• Cmd + W: Close window
• Cmd + Q: Quit application

Contributing

I warmly welcome contributions from the community. If you'd like to contribute, please fork the repository and make changes as you'd like, then create a pull request for review.

License

This project is licensed under the GPLv3 License. See the LICENSE file for details.

Credits

Created and maintained by Arthur Gareginyan, founder of Space X-Chimp.