rverst/mdsync

Simple markdown renderer with live reloading

mdsync

mdsync is like browsersync, but for markdown. It renders Markdown to HTML and reloads the browser when changes are made. Batteries included:

• Embedded fonts (Iosevka)
• Embedded style (gruvbox like; dark/light)
• Embedded highlight.js

CSS and scripts for styling and code-highlighting can be extended or replaced.

Installation

> go get -u github.com/rverst/mdsync

Usage

> mdsync example.md

This opens the default browser on http://localhost:5000 to display the rendered output.

  Usage:
    markdown sync [path]

  Positional Variables:
    path   The markdown file to render

  Flags:
       --version      Displays the program version string.
    -h --help         Displays this help.
    -c --css          A custom css path to style the output.
    -s --script       A custom script path to manipulate the output.
    -p --port         The port the server will listen on (default: 5000).
       --no-browser   Prevents the browser from being opened.
       --raw          No embedded scripts and styles, custom files will
                      work though.

With no arguments provided, the first markdown file in the current directory will be loaded.

With --css and --script custom styles or scripts can be loaded. These will be loaded after the embedded style.css or highlight.js. With the switch -raw the embedded styles and scripts can be switched off (except for the reload-script).

mdsync's Issues

Embed Iosevka web font

The fonts do not work correctly on Safari. Embedding the web font should help and additionally achieve the same result for users who do not have Iosevka installed.

Add dark mode

A switch for an additional dark mode.

Automate build process with github actions

This should be a nice opportunity to play with github actions.

Make a version without embedded fonts/embedjs - light version

To reduce the file size