Skip to main content

a package based on PySide6 designed to help you preview Markdown documents.

Project description

QMarkdownView

Description

QMarkdownView is a package based on PySide6 designed to help you preview Markdown documents.

Markdown by default supports code highlighting and LaTex mathematical formulas.

How to use

Firstly, you need to introduce the QMarkdownView library.

from QMarkdownView import MarkdownView, LinkMiddlewarePolicy

You can use the component class `MarkdownView`` we provide.

widget = MarkdownView()

MarkdownView inherits from QWebEngineView.

You can change the Markdown rendering plugin through the setExtension member function. The markup rendering engine for this function library is python-markdown.

widget.setExtensions(["markdown.extensions.tables", "markdown.extensions.extra"])

You can modify Markdown text through the setValue member function.

widget.setValue("# Hello world!")

Warning: You need to call this function after the component is loaded.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

QMarkdownView-0.2.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

QMarkdownView-0.2-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file QMarkdownView-0.2.tar.gz.

File metadata

  • Download URL: QMarkdownView-0.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for QMarkdownView-0.2.tar.gz
Algorithm Hash digest
SHA256 57f647472929c5bfd01de11e70e00a16a573a8b85353b48c31fc9b0a569f390b
MD5 da3782f580f638ae5ef595aa5c051c7b
BLAKE2b-256 f183e98cf135e150e6b63666d071d1997a50bb079e4505ff04dbb383656c7f08

See more details on using hashes here.

File details

Details for the file QMarkdownView-0.2-py3-none-any.whl.

File metadata

  • Download URL: QMarkdownView-0.2-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for QMarkdownView-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 645bb0010a8d21488edbd3767e6d63d06f437e0b1317252763ce2529ec8953e8
MD5 02420768841a34ece2c6f68b861fa7eb
BLAKE2b-256 a0103dcf599146a68064d33156406cb866cdfe606ebe117356412e6cdbf85625

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page