# 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
```sh
[<PYTHON> -m] pip[3] install [--upgrade] medit
```
## Usage
```sh
medit [<PATH>] # will open medit in given directory or on given file
```
## Development & Contribution
```sh
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:
```sh
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
* [x] File to title
* [x] File viewer for Plain, Python, YAML, JSON, ..
* [x] Autosave
* [x] Manage word wrap in editor
* [x] 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
* https://unpkg.com/browse/mermaid@8.1.0/dist/
* https://pypi.org/project/md-mermaid/
* https://github.com/oruelle/md_mermaid/issues/2
### Qt6
* https://github.com/5yutan5/PyQtDarkTheme
### QScintilla
* https://web.archive.org/web/20190604145031/https://qscintilla.com/prepare-image-hack/
### Markdown
* https://pypi.org/project/markdown-include/
* (Markdown Editor) https://github.com/jamiemcg/remarkable
### Styles / CSS
* https://thomasf.github.io/solarized-css/
* https://thomasf.github.io/solarized-css/solarized-light.css
* https://github.com/altercation/solarized
* https://github.com/sindresorhus/github-markdown-css
* https://python-markdown.github.io/extensions/code_hilite/#step-1-download-and-install-pygments
* https://github.com/richleland/pygments-css
* https://github.com/OzakIOne/markdown-github-dark
* https://github.com/sindresorhus/github-markdown-css
* https://markdowncss.github.io/
* https://github.com/markdowncss/retro
* https://mixu.net/markdown-styles/
* https://www.jsdelivr.com/package/npm/@naokim03/markdown-theme-solarized
Raw data
{
"_id": null,
"home_page": "https://projects.om-office.de/frans/medit.git",
"name": "medit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Frans F\u00fcrst",
"author_email": "frans.fuerst+gitlab@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/27/ca/5da8b9c6f4193746ba1ca35d7837bfb68a475c0153ec0793919799827fa3/medit-0.0.11.tar.gz",
"platform": null,
"description": "# MEdit - Previewing [M]arkup [Editor]\n\nA simple text editor based on PyQt6/QScintilla with the following goals in mind:\n\n- Auto-saves and tracks filesystem in order to make loading/saving obsolete\n- Syntax highlighting for typical file formats\n- Previewing markdown or representations in other file formats\n- Support for local and remote images in Markdown/reST\n- Decent nice looking interface for easily distractable people like me\n\nAs almost all of my projects, `medit` is in dangerous alpha state - use it with\ncare and don't believe anything written here.\n\n\n## Installation\n\n```sh\n[<PYTHON> -m] pip[3] install [--upgrade] medit\n```\n\n\n## Usage\n\n```sh\nmedit [<PATH>] # will open medit in given directory or on given file\n```\n\n\n## Development & Contribution\n\n```sh\npip3 install -U poetry pre-commit\ngit clone --recurse-submodules https://projects.om-office.de/frans/pocketrockit.git\ncd pocketrockit\npre-commit install\n# if you need a specific version of Python inside your dev environment\npoetry env use ~/.pyenv/versions/3.10.4/bin/python3\npoetry install\n```\n\nAfter modifications, this way a newly built wheel can be checked and installed:\n\n```sh\npoetry build\npoetry run twine check dist/medit-0.0.5-py3-none-any.whl\npython3 -m pip install --user --upgrade dist/medit-0.0.5-py3-none-any.whl\n```\n\n## My personal MLP (v1.0) goals\n\n* [x] File to title\n* [x] File viewer for Plain, Python, YAML, JSON, ..\n* [x] Autosave\n* [x] Manage word wrap in editor\n* [x] include files\n* [?] sort files by modification\n* [ ] Autoload\n* [ ] Search in files\n* [ ] spell check\n* [ ] add / remove / rename files\n* [ ] support sequence diagrams mermaid\n* [ ] Workdir/file history / Recent files\n* [ ] Multi-File Undo/Redo\n* [ ] Change into / step up current directory\n* [ ] Zen mode\n* [ ] Search/open files\n* [ ] Preview for previewable only\n* [ ] Hightlight todo.txt\n* [ ] Notify external file changes\n* [ ] (Re-)store zoom and fullscreen\n* [ ] File ignore filter\n* [ ] Icon / .desktop file\n* [ ] Proper Qt style\n* [ ] Show local images\n* [ ] Show remote images\n* [ ] Slim file / folder create / rename\n* [ ] Proper View CSS selector\n* [ ] View follows editor\n* [ ] Links clickable\n* [ ] Fix Links to support `(text)[url]` syntax\n\n\n## Feature ideas\n\n* [ ] Export to Pdf / Html / Docx ..\n* [ ] Copy / paste images\n* [ ] Drag & drop images\n* [ ] Spell checker\n* [ ] Script console with preview\n* [ ] Preview rules (markdown->HTML, xml/json/yaml -> xml/json/yaml ..)\n\n\n## Read\n\n### Mermaid\n\n* https://unpkg.com/browse/mermaid@8.1.0/dist/\n* https://pypi.org/project/md-mermaid/\n* https://github.com/oruelle/md_mermaid/issues/2\n\n\n### Qt6\n\n* https://github.com/5yutan5/PyQtDarkTheme\n\n\n### QScintilla\n\n* https://web.archive.org/web/20190604145031/https://qscintilla.com/prepare-image-hack/\n\n\n### Markdown\n\n* https://pypi.org/project/markdown-include/\n* (Markdown Editor) https://github.com/jamiemcg/remarkable\n\n\n### Styles / CSS\n\n* https://thomasf.github.io/solarized-css/\n* https://thomasf.github.io/solarized-css/solarized-light.css\n* https://github.com/altercation/solarized\n* https://github.com/sindresorhus/github-markdown-css\n* https://python-markdown.github.io/extensions/code_hilite/#step-1-download-and-install-pygments\n* https://github.com/richleland/pygments-css\n* https://github.com/OzakIOne/markdown-github-dark\n* https://github.com/sindresorhus/github-markdown-css\n* https://markdowncss.github.io/\n* https://github.com/markdowncss/retro\n* https://mixu.net/markdown-styles/\n* https://www.jsdelivr.com/package/npm/@naokim03/markdown-theme-solarized\n",
"bugtrack_url": null,
"license": "",
"summary": "Markup Editor",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://projects.om-office.de/frans/medit.git",
"Repository": "https://projects.om-office.de/frans/medit.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c59b59987ca50cca9d2044bb9bfb373e93f77961cc8d531dc14a379addbfcf8e",
"md5": "d5d149cec029e23a8b464e4587d3868b",
"sha256": "978533a2ab196e29ff98b24847acbf800f71dc7179211784c09d9dcfce3c56c2"
},
"downloads": -1,
"filename": "medit-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5d149cec029e23a8b464e4587d3868b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 89185,
"upload_time": "2023-07-29T16:02:39",
"upload_time_iso_8601": "2023-07-29T16:02:39.871480Z",
"url": "https://files.pythonhosted.org/packages/c5/9b/59987ca50cca9d2044bb9bfb373e93f77961cc8d531dc14a379addbfcf8e/medit-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27ca5da8b9c6f4193746ba1ca35d7837bfb68a475c0153ec0793919799827fa3",
"md5": "e650723d7514455a3ad70838f3244e0a",
"sha256": "842f62e650dee80dd15a89bf27c1942dd6e445a7fa6a8098ac7c973bc9a87614"
},
"downloads": -1,
"filename": "medit-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "e650723d7514455a3ad70838f3244e0a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 56622,
"upload_time": "2023-07-29T16:02:42",
"upload_time_iso_8601": "2023-07-29T16:02:42.020309Z",
"url": "https://files.pythonhosted.org/packages/27/ca/5da8b9c6f4193746ba1ca35d7837bfb68a475c0153ec0793919799827fa3/medit-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-29 16:02:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "medit"
}
JSON