Skip to main content

wxMarkdown

wxMarkdown makes adding panels of formatted text much easier! In stead of having to open and close each context yourself with a RichTextCtrl, enter what you want in Markdown and see it appear with the right styling.

Table of contents

Example

It's straight-forward. You initialise the Markdown panel as you would any other panel. You add Markdown content to it with AddContent. That's it. Embed it how you'd like.

import wx
import wxmarkdown as wxm

app = wx.App()
frame = wx.Frame(None)

md = wxm.Markdown(frame)
md.AddContent("""
# A Very Simple Example
This example doesn't showcase _all supported syntax_.
It's just meant to showcase **how to use the package**.
""")

frame.Show()
app.MainLoop()

Feature support

All basic Markdown syntax is supported. The package currently uses Markdown for parsing.

  • Italic text
  • Bold text
  • Inline code
  • Heading
  • Unordered list
  • Ordered list
  • Link
  • Image
  • Blockquote
  • Horizontal rule

You can enable the embedding of external images by setting allow_download_images to True.

To-Do

Some of these features are likely not yet implemented solely because I haven't been able to figure out wxPython's Rich Text modules fully. If you understand how the package works and know a solution for either of these todos, I would greatly appreciate if you'd get in contact with me.

  • Linkable images: This could be implemented by binding a function to the click of an image. However, I cannot get this to work within the context of a RichTextCtrl.
  • Link hover effect: Change appearance of a link upon hovering over it.
  • Horizontal Rule: A horizontal divider
  • Improve default theme

Metadata

Release files for wxMarkdown 1.0.0.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wxMarkdown 1.0.0.post1
File Size Uploaded
wxMarkdown-1.0.0.post1.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wxMarkdown 1.0.0.post1
File Interpreter ABI Platform
wxMarkdown-1.0.0.post1-py3-none-any.whl Python 3 none any Details

Total release size: 14.5 kB

Release files / wxMarkdown-1.0.0.post1.tar.gz

Download URL wxMarkdown-1.0.0.post1.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ed898d7b1324edc343dda60bb38407ac770202393395ccc98d23dd468c054639
BLAKE2b-256 checksum
How to use checksums
7ea849ca5cf5fd061e3faedc4bb3ff742992b07420d3271fd244d39b1b5b0ecb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / wxMarkdown-1.0.0.post1-py3-none-any.whl

Download URL wxMarkdown-1.0.0.post1-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4428ff88a8c171868476df0f92f66c6704793e3cbcb215c485e6c3966b50c7fe
BLAKE2b-256 checksum
How to use checksums
e3fc28ffc5fed40d7340ba470167b7a95b780ee230a66adf26622e8dd5e377c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release history Release notifications | RSS feed

This release

1.0.0.post1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page