diff options
| author | altaf-creator <64111012+altaf-creator@users.noreply.github.com> | 2023-05-10 22:02:52 +0700 |
|---|---|---|
| committer | altaf-creator <64111012+altaf-creator@users.noreply.github.com> | 2023-05-10 22:02:52 +0700 |
| commit | a62a7631cbdb56246822dd72bd965e4ed1c883c2 (patch) | |
| tree | 667b706e2426e36b2129717ce8b88a06bb866da2 | |
| parent | d9977bd7d661ba93978713b5584bb4d4aa1854e1 (diff) | |
| parent | b8b2060d7ea3af082e313003c4bbc014ebd591c8 (diff) | |
| -rw-r--r-- | README.md | 62 |
1 files changed, 61 insertions, 1 deletions
@@ -1 +1,61 @@ -# MarkdownEditor
\ No newline at end of file +# 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 + + + + + + + + + +## 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/). |
