https://github.com/tim-gromeyer/markdownedit
Experience the speed and simplicity of MarkdownEdit
https://github.com/tim-gromeyer/markdownedit
editor markdown-editor markdown-to-html markdown-viewer qt5
Last synced: about 1 year ago
JSON representation
Experience the speed and simplicity of MarkdownEdit
- Host: GitHub
- URL: https://github.com/tim-gromeyer/markdownedit
- Owner: tim-gromeyer
- License: gpl-3.0
- Archived: true
- Created: 2022-03-04T14:18:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T06:38:15.000Z (about 2 years ago)
- Last Synced: 2025-03-30T19:21:51.315Z (about 1 year ago)
- Topics: editor, markdown-editor, markdown-to-html, markdown-viewer, qt5
- Language: C++
- Homepage: https://tim-gromeyer.github.io/MarkdownEdit
- Size: 56.3 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.codefactor.io/repository/github/tim-gromeyer/markdownedit/overview/main)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/tim-gromeyer/MarkdownEdit/releases/)
# [MarkdownEdit](https://tim-gromeyer.github.io/MarkdownEdit/)
Experience the speed and simplicity of MarkdownEdit
## Table of Contents
1. [Features](#features)
2. [Preview](#preview)
3. [Dependencies](#dependencies)
4. [Build instructions](#build-instructions)
5. [Credits](#credits)
## Features
MarkdownEdit offers a range of powerful features to make editing and creating Markdown files quick and easy:
- **Spell checker**
- Save and load Markdown files quickly and easily
- Powerful undo/redo capabilities
- **Real-time Markdown preview**
- **Editor with syntax highlighting**
- Auto-completion for brackets, lists, and more
- Find/replace functionality for efficient editing
- Export to HTML and PDF
- Lightweight and resource-efficient
- Quick access to recent files from the toolbar or file menu
- Open source and native look and feel
# Screenshots
Live preview enabled
Live preview disabled
Preview only
## Preview
(Note: Bugs are expected, it's a desktop app and not a web app)
You can preview MarkdownEdit in action [here](https://tim-gromeyer.github.io/MarkdownEdit/markdownedit.html).
Please note:
- The online preview may not perform as well as the actual app
- Spell check is not available in the online preview
- Drag and drop functionality is not supported in the online preview
## Dependencies
MarkdownEdit requires [Qt](https://qt.io/) and [nuspell](https://github.com/nuspell/nuspell) (optional) to be installed.
## Build instructions
To build MarkdownEdit, follow these steps:
1. Clone the MarkdownEdit repository: `git clone https://github.com/tim-gromeyer/MarkdownEdit --depth=1 && cd MarkdownEdit`
2. Initialize and update the submodules: `git submodule update --init --recursive -j 3 --depth=1`
3. Create a build directory and navigate to it: `mkdir build && cd build`
4. Generate a Makefile using CMake: `cmake ..`
5. Build the project: `cmake --build . -j4`
## Credits
- Thanks to [Waqar Ahmed](https://github.com/Waqar144) for help with development.
- The conversion from Markdown to HTML is done using the [md4c](https://github.com/mity/md4c) library by *Martin Mitáš*.
- The [widget](https://github.com/pbek/qmarkdowntextedit) used for writing was created by *Patrizio Bekerle*.