aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e3bfe795cb11624462e05f17882f75f548f49f04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# MarkdownEditor - a basic markdown viewer and editor

<img src="/MarkdownEditor/icon_markdowneditor.png" width="400px" align="right">

Hello, World! MarkdownEditor is a markdown viewer and editor with all of the essential features.
> Note: MarkdownEditor is currently only available for Windows (64-bit).

## Features
- All markdown features, except:
	- Definition List
	- Emojis
- Built-in directory file viewer
- (almost) Real-time preview
- Export to HTML (without CSS)
- Open folders
- Lightweight

## Screenshots

![screenshot1](https://i.imgur.com/tk6emRx.png)
  
![screenshot2](https://i.imgur.com/b6rsFat.png)
  
![screenshot3](https://i.imgur.com/tGq2Nlr.png)

![screenshot4](https://i.imgur.com/t8Pedm4.png)

## Usage
- 💾: Save  
- 💾, but blue: Save As
- 📤: Export to HTML
- 📂: Open
- đŸ—ƒī¸: Open Folder
- â„šī¸: About

## Installation
> NOTE: Currently only available for Windows 64-bit
### Download from Releases
1. Unzip the file
2. Open the shortcut named `MarkdownEditor`  
3. or navigate to `/bin/`, then open `MarkdownEditor.exe`

### Compile using Visual Studio
1. Open Visual Studio
2. Click "Clone Repository" below "Get Started" section
3. Copy and Paste this link [https://github.com/altaf-creator/MarkdownEditor](https://github.com/altaf-creator/MarkdownEditor) into the "Repository Location" text box.
4. Click "Clone"
5. Change debugging target to "x64"
5. Click "â–ļ MarkdownEditor" to compile
6. The compiled build will be located at `\MarkdownEditor\bin\x64\Debug\net48\MarkdownEditor.exe`.

## Credits
- [CefSharp](https://github.com/cefsharp/CefSharp) - chromium wrapper
- [Markdig](https://github.com/xoofx/markdig) - markdown parser
- [Ookii Dialogs](https://github.com/ookii-dialogs/ookii-dialogs-wpf) - open folder dialog
- .NET C# WPF
- Visual Studio 2022

---

Licensed under the [MIT License](https://mit-license.org/).