Skip to content

doc-bricks/CleanMarkdown

CleanMarkdown

Fast local Markdown viewer and editor with a clean reading mode, raw Markdown editing, PDF export, and DE/EN UI.

Deutsche README

Features

  • Two clear tabs: Reading and Editor
  • Raw Markdown editor with helper buttons instead of WYSIWYG complexity
  • Clean rendered reading view
  • PDF export with timestamp-based filenames
  • Autosave with configurable interval
  • German and English UI
  • Light and dark theme
  • Optional top action bar for a cleaner default layout
  • Calm syntax highlighting for key Markdown groups

Screenshot

CleanMarkdown main window

Installation

Requirements

  • Windows with Python 3.12+
  • Packages from requirements.txt

Steps

python -m pip install -r requirements.txt
python main.py

Or start it directly on Windows:

start.bat

Usage

  1. Open a Markdown file from File -> Open... or start writing in the editor.
  2. Switch between Reading and Editor with the two tabs.
  3. Use the editor helper buttons to insert or format Markdown structures.
  4. Export the current document via File -> Export PDF.
  5. Adjust language, theme, autosave, export behavior, and toolbar visibility in View -> Settings.

Editor Highlighting

The raw editor uses a restrained four-group color system:

  • Blue for headings and emphasis
  • Green for inline code and fenced code blocks
  • Pink/magenta for links, images, and footnotes
  • Soft gray-violet for lists, quotes, tables, and structural markers

Project Status

Current version: 0.2.0

CleanMarkdown is already usable as a small public MVP. The current focus is practical polish around real-world rendering and PDF export, not feature bloat.

Development

python -m py_compile main.py
python main.py --self-test
python main.py

License

This project is licensed under the MIT License.

About

Fast local Markdown viewer and editor with clean reading mode, raw Markdown editing, PDF export, and DE/EN UI.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors