Markdown Viewer

Markdown Viewer is a native Markdown reader and editor designed specifically for the GNOME desktop environment. Developed in Vala using GTK 4 and libadwaita, this application allows users to effortlessly browse and manage their Markdown files within an intuitive folder tree structure. The unique feature of Markdown Viewer is its ability to parse and render Markdown directly into native widgets without relying on a web engine or HTML library, ensuring a seamless user experience.

Key Features

• User-Friendly Interface: Easily open any folder to view and interact with Markdown files, all organized in a handy sidebar. The interface supports viewing and editing notes simultaneously, enhancing productivity.

• Dynamic File Management: The application automatically updates the sidebar as files change, making it easy to keep track of edits made by other applications. Users can quickly create new notes and folders with just a few clicks.

• Intelligent Text Handling: Changes made in Markdown files will show up in real time if opened in another program, balancing collaborative work with personal editing sessions. Additionally, notes create drafts for new text automatically, prompting users to save or discard unsaved changes when switching contexts.

• Versatile Markdown Support: Supports common Markdown features such as headings, emphasis, links, images, tables, and even diagrams using Mermaid syntax. This allows for rich content creation, including flowcharts and other diagram types neatly integrated within notes.

• Customizable Appearance: Text size adjustments and a dark mode option enhance readability and use conducive to different working environments.

• Search Functionality: Quickly locate Markdown files or specific content within files using the search functionality located at the top of the sidebar.

• Future-Proof Design: Automatically manages user settings such as last opened directory and window state through a straightforward state management system.

Code Structure

The application is built with a modular architecture, facilitating straightforward maintenance and contributions. Key components include:

• src/markdown/parser.vala: Handles block parsing for lists, quotes, and tables.
• src/widgets/file-tree.vala: Manages the folder tree and file search functionalities.
• src/editor.vala: Provides source editing features including list continuation.

Markdown Viewer represents an ideal solution for users seeking a dedicated Markdown environment within GNOME, blending functionality with simplicity and elegance.