https://github.com/t9air/marked
An intuitive, cross-platform, real-time Markdown editor built with Python
https://github.com/t9air/marked
markdown markdown-editor markdown-parser markdown-parsing-rendering python python3 tkinter tkinter-gui
Last synced: 2 months ago
JSON representation
An intuitive, cross-platform, real-time Markdown editor built with Python
- Host: GitHub
- URL: https://github.com/t9air/marked
- Owner: T9Air
- License: agpl-3.0
- Created: 2024-10-21T22:58:06.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T03:38:14.000Z (6 months ago)
- Last Synced: 2025-01-18T11:27:14.029Z (4 months ago)
- Topics: markdown, markdown-editor, markdown-parser, markdown-parsing-rendering, python, python3, tkinter, tkinter-gui
- Language: Python
- Homepage:
- Size: 193 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: Docs/supported-code.md
- Roadmap: Docs/roadmap.md
Awesome Lists containing this project
README
# MarkEd
An intuitive, cross-platform, real-time Markdown editor built with Python
## Installation
### Windows
1. Download the latest .exe installer from the [Releases page](https://github.com/T9Air/MarkEd/releases)
2. If Windows displays a warning during download, click "Keep anyway" to proceed.
3. Run the installer. If you see a SmartScreen warning, click "More info" and then "Run anyway" to continue.
4. Follow the installation prompts to complete the setup.
5. Launch the program from your Start Menu or the newly created Desktop shortcut.
> Important Note: Due to the price our application is not code-signed. This may trigger Windows security warnings, but rest assured that our software is safe to use.
### MacOS
1. Download the latest .dmg package from our [Releases page](https://github.com/T9Air/MarkEd/releases).
2. Open the DMG file and drag the ScreenVivid icon to the Applications folder.
3. Run the app from your Applications folder.
> Important Note: As the app is not notarized, Gatekeeper may display a warning. To proceed, go to System Settings > Privacy & Security > Security, select "Open Anyway", and confirm with your login password. For more information, please refer to [this guide](https://support.apple.com/en-vn/guide/mac-help/mchleab3a043/mac).
### Linux
Download the latest .deb package from our [Releases page](https://github.com/T9Air/MarkEd/releases).
```bash
sudo dpkg -i MarkEd-x.x.x.deb
```
## [Docs](https://github.com/T9Air/MarkEd/tree/main/Docs)
- Code Explanation
- [Parser](https://github.com/T9Air/MarkEd/blob/main/Docs/parser-explanation.md)
- [Converter](https://github.com/T9Air/MarkEd/blob/main/Docs/converter-explanation.md)
- [Currently working Markdown syntax](https://github.com/T9Air/MarkEd/blob/main/Docs/supported-code.md)
- [Roadmap](https://github.com/T9Air/MarkEd/blob/main/Docs/roadmap.md)
- [Changelog](https://github.com/T9Air/MarkEd/blob/main/Docs/CHANGELOG.md)
## License
This repository is licensed under the [GNU AGPL v3.0 license](https://github.com/T9Air/MarkEd/blob/main/LICENSE)