Skip to main content

Markup Editor

Project description

MEdit - Previewing [M]arkup [Editor]

A simple text editor based on PyQt6/QScintilla with the following goals in mind:

  • Auto-saves and tracks filesystem in order to make loading/saving obsolete
  • Syntax highlighting for typical file formats
  • Previewing markdown or representations in other file formats
  • Support for local and remote images in Markdown/reST
  • Decent nice looking interface for easily distractable people like me

As almost all of my projects, medit is in dangerous alpha state - use it with care and don't believe anything written here.

Installation

[<PYTHON> -m] pip[3] install [--upgrade] medit

Usage

medit [<PATH>]  # will open medit in given directory or on given file

Development & Contribution

pip3 install -U poetry pre-commit
git clone --recurse-submodules https://projects.om-office.de/frans/pocketrockit.git
cd pocketrockit
pre-commit install
# if you need a specific version of Python inside your dev environment
poetry env use ~/.pyenv/versions/3.10.4/bin/python3
poetry install

After modifications, this way a newly built wheel can be checked and installed:

poetry build
poetry run twine check dist/medit-0.0.5-py3-none-any.whl
python3 -m pip install --user --upgrade dist/medit-0.0.5-py3-none-any.whl

My personal MLP (v1.0) goals

  • File to title
  • File viewer for Plain, Python, YAML, JSON, ..
  • Autosave
  • Manage word wrap in editor
  • include files
  • [?] sort files by modification
  • Autoload
  • Search in files
  • spell check
  • add / remove / rename files
  • support sequence diagrams mermaid
  • Workdir/file history / Recent files
  • Multi-File Undo/Redo
  • Change into / step up current directory
  • Zen mode
  • Search/open files
  • Preview for previewable only
  • Hightlight todo.txt
  • Notify external file changes
  • (Re-)store zoom and fullscreen
  • File ignore filter
  • Icon / .desktop file
  • Proper Qt style
  • Show local images
  • Show remote images
  • Slim file / folder create / rename
  • Proper View CSS selector
  • View follows editor
  • Links clickable
  • Fix Links to support (text)[url] syntax

Feature ideas

  • Export to Pdf / Html / Docx ..
  • Copy / paste images
  • Drag & drop images
  • Spell checker
  • Script console with preview
  • Preview rules (markdown->HTML, xml/json/yaml -> xml/json/yaml ..)

Read

Mermaid

Qt6

QScintilla

Markdown

Styles / CSS

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

medit-0.0.11.tar.gz (56.6 kB view details)

Uploaded Source

Built Distribution

medit-0.0.11-py3-none-any.whl (89.2 kB view details)

Uploaded Python 3

File details

Details for the file medit-0.0.11.tar.gz.

File metadata

  • Download URL: medit-0.0.11.tar.gz
  • Upload date:
  • Size: 56.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/6.2.15-100.fc36.x86_64

File hashes

Hashes for medit-0.0.11.tar.gz
Algorithm Hash digest
SHA256 842f62e650dee80dd15a89bf27c1942dd6e445a7fa6a8098ac7c973bc9a87614
MD5 e650723d7514455a3ad70838f3244e0a
BLAKE2b-256 27ca5da8b9c6f4193746ba1ca35d7837bfb68a475c0153ec0793919799827fa3

See more details on using hashes here.

File details

Details for the file medit-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: medit-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 89.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/6.2.15-100.fc36.x86_64

File hashes

Hashes for medit-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 978533a2ab196e29ff98b24847acbf800f71dc7179211784c09d9dcfce3c56c2
MD5 d5d149cec029e23a8b464e4587d3868b
BLAKE2b-256 c59b59987ca50cca9d2044bb9bfb373e93f77961cc8d531dc14a379addbfcf8e

See more details on using hashes here.

Supported by

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