(Markdown) Document instant preview.
Inspired by grip.
- Offline-first: Dip renders Markdown like Github does with the help of goldmark and github-markdown-css - CSS/JS assets are bundled.
- Flexible: Dip can read from standard input, files, directories and even URLs! (WIP)
- Fast (reasonably): Dip's server is written in Go with client-side Typescript for live reloading.
Disclaimer: Dip is intended primarily for development, and is not meant to be hosted as an online service. Live reloading is implemented by Server-Sent Events over HTTP/2 Cleartext so connections are not secure.
dip [<path>] [<address>], where path is the directory or file to serve as HTML, and address is the TCP address and/or port.
The default is equivalent to dip . 8080, which serves the current directory at port 8080 on all interfaces.
go install github.com/ongyx/dip/cmd/dip@latest
Dip is composed of a server (cmd/, internal/) that serves static Javascript (src/) to clients.
For ease of installation, the bundled assets are checked into this repository under pkg/asset/dist.
You may want to update them periodically with:
npm update
npm run fmt && npm run build
After which you can start the server with npm run serve.
Dip is licensed under the MIT License.