Skip to content

milinddethe15/render-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Render-MD: A Client-Side Markdown Editor

Render-MD is a lightweight client-side Markdown editor built with Go + WebAssembly. It provides real-time Markdown preview with syntax highlighting, making it a powerful tool for writing and formatting Markdown directly in the browser.

This is a learning project to explore Go WebAssembly and how it can be used for frontend applications.

Installation & Running Locally

1️⃣ Clone the Repository

git clone https://github.com/milinddethe15/render-md.git
cd render-md

2️⃣ Build WebAssembly (WASM) Run the following command to compile the Go code into a .wasm file:

GOOS=js GOARCH=wasm go build -o main.wasm main.go

3️⃣ Copy WebAssembly Runtime File Copy wasm_exec.js (required to run WASM in the browser):

cp "$(go env GOROOT)/misc/wasm/wasm_exec.js" .

4️⃣ Start a Local Server You cannot open the HTML file directly due to WebAssembly security restrictions. Use a local web server:

python3 -m http.server 8080
#or
goexec 'http.ListenAndServe(":8080", http.FileServer(http.Dir(".")))'

Then open: http://localhost:8080/

Technologies Used

  • Go (for WebAssembly)
  • Goldmark (Markdown parser)
  • highlight.js (Syntax highlighting)
  • HTML/CSS/JavaScript (Frontend)
  • GitHub Pages (Hosting)

License

This project is open-source and available under the MIT License.

About

Client side markdown web-based editor built with go & wasm

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published