Skip to main content

Add your description here

Project description

md2wxhtml

A tool to convert Markdown files into a format suitable for WeChat articles, handling general content and code blocks with syntax highlighting.

Features

  • Converts Markdown to HTML.
  • Separates and processes code blocks for syntax highlighting and horizontal scrolling.
  • Merges processed content and code blocks into a single HTML document.

Disclaimer

This project is an independent open-source tool and is not affiliated with, endorsed by, or officially connected to WeChat or Tencent.

Installation

pip install md2wxhtml

Usage

Command-line Interface

md2wxhtml --input <input_file.md> --output <output_file.html>

As a Python Library

from md2wxhtml import WeChatConverter

converter = WeChatConverter(content_theme="blue", code_theme="monokai")
conversion_result = converter.convert("Your markdown content here.")
html_output = conversion_result.html
print(html_output)

Available Themes

The content_theme argument accepts the following built-in theme names:

  • default
  • blue
  • dark
  • github
  • green
  • hammer
  • red

The code_theme argument uses Pygments styles for code highlighting. You can specify any valid Pygments style name (e.g., monokai, default, friendly, colorful, etc.) to adjust the appearance of code blocks.

You can specify these names when creating a WeChatConverter instance. For example:

converter = WeChatConverter(content_theme="github", code_theme="monokai")

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

md2wxhtml-0.1.13.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

md2wxhtml-0.1.13-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file md2wxhtml-0.1.13.tar.gz.

File metadata

  • Download URL: md2wxhtml-0.1.13.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for md2wxhtml-0.1.13.tar.gz
Algorithm Hash digest
SHA256 55c0f24361208b50cac6174bfef805e47240e00b244ce94d0c68bea879a84399
MD5 ad78a7d2331c571409dc70fa7403e674
BLAKE2b-256 bc2831452e0e685c9f6cae63ed9a06d73b23f65cfa2ee4f64f5b1d117bb79fdb

See more details on using hashes here.

Provenance

The following attestation bundles were made for md2wxhtml-0.1.13.tar.gz:

Publisher: publish.yml on Wenjun-Mao/md2wxhtml

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file md2wxhtml-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: md2wxhtml-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for md2wxhtml-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 27ce9ec6dde54fb56cf2ca9a5e55d72b27797b8b6a685ea4d476c584f6a91e9d
MD5 cf9c7d0bc1d3a7881bff3dcac31d2a41
BLAKE2b-256 a642c9fd9bd67d9f54008dddc5e8e216fa89978d92af6d8a7df9893511f8ddd8

See more details on using hashes here.

Provenance

The following attestation bundles were made for md2wxhtml-0.1.13-py3-none-any.whl:

Publisher: publish.yml on Wenjun-Mao/md2wxhtml

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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