Skip to content

Commit 396f256

Browse files
authored
Update README.md
1 parent 700f38d commit 396f256

File tree

1 file changed

+86
-2
lines changed

1 file changed

+86
-2
lines changed

README.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,86 @@
1-
# syntax.md
2-
A stupidly fast markdown file editor.
1+
# syntax.md ✍️💥
2+
3+
a stupidly fast markdown editor & previewer that looks cool and just works™
4+
powered by html/css/js + webview2 + vibes + spite
5+
6+
---
7+
8+
## ✨ Features
9+
10+
- ✅ live markdown preview
11+
- ✅ highlight.js for code blocks
12+
- ✅ dark mode default
13+
- ✅ saves as `.md`
14+
- ✅ portable & clean
15+
- ✅ zero dependencies after first launch
16+
- ✅ pulls the html+js from a GitHub archive automatically
17+
- ✅ webview2 powered
18+
- ✅ no telemetry, no BS, just vibes
19+
20+
---
21+
22+
## 🚀 Usage
23+
24+
```sh
25+
Download & run `syntaxmd.exe`
26+
```
27+
28+
On first launch, it will:
29+
30+
1. download the UI archive from GitHub
31+
2. unzip to `%LocalAppData%\syntaxmd\`
32+
3. open `index.html` in a WebView2 window
33+
34+
after that, it just loads from that local dir. no internet required.
35+
36+
---
37+
38+
## 📦 Build Instructions (Optional)
39+
40+
1. open the project in Visual Studio 2022+
41+
2. make sure you're on **.NET 6 or 7**
42+
3. install the **WebView2 SDK**
43+
4. build `Release` configuration
44+
5. run or publish (`right-click project > Publish` if you want)
45+
46+
---
47+
48+
## 🗃️ Structure
49+
50+
```txt
51+
syntaxmd/
52+
├── index.html
53+
├── script.js
54+
├── styles.css
55+
├── highlight/
56+
│ └── highlight.min.js
57+
└── syntaxmd.exe (WinForms + WebView2)
58+
```
59+
60+
---
61+
62+
## 💾 Save Behavior
63+
64+
- click the `💾 Save` button
65+
- it downloads your markdown editor contents as a `.md` file
66+
67+
---
68+
69+
## 🧃 Notes
70+
71+
- you need [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)
72+
- built with 💔 and copium
73+
- tested on Windows 10/11
74+
75+
---
76+
77+
## 🧛 credits
78+
79+
- made by [burned toast](https://github.com/ur-url-here)
80+
- UI powered by markdown, highlight.js, and black magic
81+
82+
---
83+
84+
## 📜 license
85+
86+
MIT. idc what u do with it. fork it, sell it, tattoo it on your dog.

0 commit comments

Comments
 (0)