Skip to content

yaragirodev/MarkE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkE - Markdown Editor

"The easiest way to write beautiful README.md files"

Python
Version
License
Platform

Markdown Editor Preview

✨ Features

  • Real-time Markdown preview
  • Export to .md
  • Syntax highlighting

🚀 Installation

From Source

  1. Clone the repository:

    git clone https://github.com/portalius-dev/MarkE.git
    cd MarkE
  2. Install dependencies:

    pip install -r requirements.txt
  3. Run the application:

    python main.py

Requirements

  • Python 3.8+
  • PyQt5
  • markdown
  • tempfile

📦 Building the Application

Using auto-py-to-exe

  1. Install the builder:

    pip install auto-py-to-exe
  2. Configure the build:

    • Select main.py as the script
    • Choose "One Directory" or "One File" mode
    • Add an icon (optional)
    • Set output directory
  3. Click "Convert .py to .exe"

📝 Usage

  1. Write your Markdown in the left panel
  2. See real-time preview on the right
  3. Use the toolbar for:
    • Saving files (.md, .html)
    • Exporting documents
    • Open file in browser.

📜 License

This project is licensed under the GNU GPL v3 License - see the LICENSE file for details.

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.

About

Simple markdown text editor.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages