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.1.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: QMarkdownView-0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 3fdde3c6ad1e093ae63cacf2d11a99862243396ef5fd88b4ee3f63c5f200fe54
MD5 934de0305d6caa81f514e0060bac7125
BLAKE2b-256 783b3e5d3df410d75963df8b9ca83c88e1f576d71d8394add326c7b4dbb75b17

See more details on using hashes here.

File details

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

File metadata

  • Download URL: QMarkdownView-0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc124699d5c1d4f3f04afc97cbeb365c2e55bc60a8db5149066e6c23e606250c
MD5 cce27af78dd36ebf1bcb64e7c73b0024
BLAKE2b-256 15c6790fa9bebdd7713e6c5c6f3556b099fb4e7227946bc8921c8a8e1425a9b2

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