https://github.com/rverst/mdsync

Simple markdown renderer with live reloading
https://github.com/rverst/mdsync

browser-sync development live-reload markdown markdown-previewer markdown-viewer

Last synced: 3 months ago
JSON representation

Simple markdown renderer with live reloading

• Host: GitHub
• URL: https://github.com/rverst/mdsync
• Owner: rverst
• License: mit
• Created: 2020-09-10T19:03:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-09T12:02:08.000Z (almost 3 years ago)
• Last Synced: 2024-06-19T23:15:08.974Z (8 months ago)
• Topics: browser-sync, development, live-reload, markdown, markdown-previewer, markdown-viewer
• Language: CSS
• Homepage:
• Size: 18.1 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdsync

`mdsync` is like [browsersync](https://github.com/schollz/browsersync), but for markdown.

It renders Markdown to HTML and reloads the browser when changes are made.

Batteries included:

  - Embedded fonts ([Iosevka](https://github.com/be5invis/Iosevka))

  - Embedded style (gruvbox like; dark/light)

  - Embedded [highlight.js](https://highlightjs.org/)

![image alt <>](./docs/dark_light.png)

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

## Installation

```shell

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

```

## Usage

```shell

> mdsync example.md

```

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

```shell

  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](embedded/www/css/style.css) or [highlight.js](embedded/www/script/highlight.js).

With the switch -raw the embedded styles and scripts can be switched off (except for the reload-script).