ctk-markdown 0.1.0

Markdown Renderer for customtkinter

ctk-markdown

ctk-markdown is a CustomTkinter Markdown renderer based on CTkTextbox. It applies rich tags for headings, lists, tables, code blocks, and inline formatting.

✨ Features

• Single widget (CTkMarkdown) with Markdown rendering
• Headings, lists, blockquotes, tables, and code blocks
• Basic syntax highlighting for Python and JavaScript
• Theme-aware colors for light and dark appearance modes

📦 Installation

pip install ctk-markdown

🚀 Usage

from ctk_markdown import CTkMarkdown
import customtkinter as ctk

app = ctk.CTk()
frame = ctk.CTkFrame(app)
frame.pack(fill="both", expand=True, padx=16, pady=16)

renderer = CTkMarkdown(frame)
renderer.pack(fill="both", expand=True)
renderer.set_markdown("""# Title\nText with *italic* and **bold**.""")

app.mainloop()

🧠 How it works

The widget inherits from CTkTextbox. Markdown parsing is done line by line and uses Tkinter text tags for styling. Theme colors are applied based on the current CustomTkinter appearance mode.

🧪 Run the demo

python example.py

🤝 Contributing

Contributions are welcome!

1. Fork the repo
2. Create a feature branch (feature/my-change)
3. Commit your changes
4. Open a Pull Request with a clear description

Ideas:

• More language grammars for code highlighting
• Image support
• Clickable links

📄 License

Choose a license (e.g., MIT) before publishing to GitHub.