https://github.com/nilsherzig/live-markdown-preview
https://github.com/nilsherzig/live-markdown-preview
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nilsherzig/live-markdown-preview
- Owner: nilsherzig
- License: mit
- Created: 2023-08-15T13:27:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T13:42:46.000Z (almost 3 years ago)
- Last Synced: 2025-03-04T22:42:02.759Z (over 1 year ago)
- Language: CSS
- Size: 44.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## WIP! Check commit logs
## Usage
```bash
go run . ~/the/folder/you/want/to/monitor
# or build it
go build .
./helix-markdown-preview ~/the/folder/you/want/to/monitor
```
## Working:
- rendering ms after file change
- support multiple files in same folder
- background file change monitoring
- rendering using the gin web server library and web sockets
- mermaid diagrams
- code highlight
- GitHub markdown support
- GitHub markdown theme
- templates and scripts are now embedded into the binary during the build process
- recursive folder monitoring
- remember theme via browser local storage
## Things I would like to change / implement
- health check from web socket (ping - pong) - close website on disconnect
- preview binary disconnects web socket on normal exit `SIGTERM`
- helix doesn't seem to send `SIGTERM` to child processes on exit
- getting math / latex to render
- everything included, no network connection needed (I don't know how copyright works)
- Custom kanban renderer / parser
- run parser as marked extension in client side JS
- using a code block (?)
- Somehow add kanban auto formatting to helix (pipe to external script?)
- Automatically start when helix opens a markdown file
- scroll to current position
- I don't know how to get the current line number from helix, maybe scroll to last edit?