diff options
| author | altaf-creator <64111012+altaf-creator@users.noreply.github.com> | 2023-03-19 13:17:26 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-19 13:17:26 +0700 |
| commit | c7c93c15d120afd31a6c748e84796a1c5fa530fa (patch) | |
| tree | 4304380eb08a2bb8e9a0f3f5ffa305e40099b332 | |
| parent | 060455998a74b93eb8ac3b8627d54ca7b9e61146 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 61 |
1 files changed, 60 insertions, 1 deletions
@@ -1 +1,60 @@ -# MarkdownEditor
\ No newline at end of file +# MarkdownEditor - a basic markdown viewer and editor + +<img src="https://bnz06pap002files.storage.live.com/y4mk6n9G0Hk7i1LBentxzK8QmNzJs3MvZ6V3GZRFegN8K09xV8DnmLZmAZWYXZnw9y_xK0nfIX45fsyITRXL5J4lbNfpQ-YDnaMcFK0M5gGfInfHefyNrXVTbHQ2dtFSTH3H2uCQTy6lFj-1iKt0Ocoz_m8kDf6yU67ij-uEhsWHJInqWSvC-Gz_mP3zMGABf8M?encodeFailures=1&width=210&height=945" 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 +Open the shortcut named `MarkdownEditor` +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 `\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/). |
