https://github.com/yuriidorosh/markdown-viewer

"Markdown Viewer" is a simple GTK-based application to view Markdown files.
https://github.com/yuriidorosh/markdown-viewer

c c-language c-language-programming gtk gtk3 markdowm markdown-parser markdown-to-html markdown-viewer

Last synced: 3 months ago
JSON representation

"Markdown Viewer" is a simple GTK-based application to view Markdown files.

• Host: GitHub
• URL: https://github.com/yuriidorosh/markdown-viewer
• Owner: YuriiDorosh
• License: mit
• Created: 2023-08-01T15:19:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-08T15:33:09.000Z (almost 2 years ago)
• Last Synced: 2025-03-30T23:12:30.072Z (3 months ago)
• Topics: c, c-language, c-language-programming, gtk, gtk3, markdowm, markdown-parser, markdown-to-html, markdown-viewer
• Language: C
• Homepage:
• Size: 7.81 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Introduction

[![video_deconstration](https://img.youtube.com/vi/oADotso-z_E/0.jpg)](https://www.youtube.com/watch?v=oADotso-z_E)

"Markdown Viewer" is a simple GTK-based application to view Markdown files. This application allows users to:

- Convert the displayed Markdown content to HTML.

- Save the rendered HTML content to a file.

- Preview the HTML content in a web browser.

## Prerequisites

- `gtk3` - The GTK+ graphical UI library.

- `cmark` - A C implementation of CommonMark.

Inside the application:

1. Click on "Open .md File" to select a Markdown file you wish to view.

2. The Markdown content will be displayed in the main view.

3. Click on "Save HTML" to save the rendered HTML content to a file.

4. Click on "Open in Browser" to preview the rendered content in your default web browser.

## Features

1. **Markdown Display**: The application reads and displays the content of Markdown files.

2. **HTML Rendering**: Uses the `cmark` library to convert Markdown content to an HTML string.

3. **File Interactions**: Provides options to open Markdown files and save the rendered HTML content.

4. **Browser Preview**: Allows users to view the rendered HTML in a browser.

## Known Issues

- The "Open in Browser" function uses `xdg-open temp.html` which works for Linux-based systems. For cross-platform compatibility, this might need adjustments.

## Contribution

Feel free to fork, modify, and submit pull requests. Ensure you test your code before submitting any changes.

## License

This project is open-source. Ensure you reference it if used for any of your projects.