https://github.com/kde/markdownpart
KPart for rendering Markdown content
https://github.com/kde/markdownpart
Last synced: about 1 month ago
JSON representation
KPart for rendering Markdown content
- Host: GitHub
- URL: https://github.com/kde/markdownpart
- Owner: KDE
- Created: 2020-08-15T14:32:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T13:27:16.000Z (about 1 year ago)
- Last Synced: 2024-05-01T12:02:06.153Z (about 1 year ago)
- Language: C++
- Homepage: https://invent.kde.org/utilities/markdownpart
- Size: 420 KB
- Stars: 7
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSES/LGPL-2.1-or-later.txt
Awesome Lists containing this project
README
# Markdown Viewer KPart (QTextDocument-based)
## Introduction
This repository contains software for the rendered display of Markdown documents:
* a Markdown viewer [KParts](https://api.kde.org/frameworks/kparts/html/index.html) plugin, which allows KParts-using applications to display files in Markdown format in the target format
The software is mainly a wrapper around the classes [QTextDocument](https://doc.qt.io/qt-5/qtextdocument.html) and [QTextBrowser](https://doc.qt.io/qt-5/qtextbrowser.html) from Qt's QWidgets library. The Markdown support is thus completely driven by the abilities of those classes.
## Using
To use the MarkdownPart KParts plugin in a KParts-using applications, often you will need to configure that globally in the Plasma System Settings, and there in the "File Associations" page.
Select the MIME type "text/markdown" and in the "Embedding" tab in the "Service Preference Order" group make sure "Markdown View (markdownpart)" is on top of the list.
## Issues
Please report bugs and feature requests in the [KDE issue tracker](https://bugs.kde.org/enter_bug.cgi?product=markdownpart).