{"id":20108052,"url":"https://github.com/rverst/mdsync","last_synced_at":"2025-05-06T09:33:08.214Z","repository":{"id":45639861,"uuid":"294498502","full_name":"rverst/mdsync","owner":"rverst","description":"Simple markdown renderer with live reloading","archived":false,"fork":false,"pushed_at":"2022-04-09T12:02:08.000Z","size":19008,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T11:11:58.797Z","etag":null,"topics":["browser-sync","development","live-reload","markdown","markdown-previewer","markdown-viewer"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rverst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-10T19:03:06.000Z","updated_at":"2024-06-27T08:46:13.000Z","dependencies_parsed_at":"2022-09-10T19:11:33.967Z","dependency_job_id":null,"html_url":"https://github.com/rverst/mdsync","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rverst%2Fmdsync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rverst%2Fmdsync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rverst%2Fmdsync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rverst%2Fmdsync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rverst","download_url":"https://codeload.github.com/rverst/mdsync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252657479,"owners_count":21783830,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser-sync","development","live-reload","markdown","markdown-previewer","markdown-viewer"],"created_at":"2024-11-13T17:59:25.925Z","updated_at":"2025-05-06T09:33:07.694Z","avatar_url":"https://github.com/rverst.png","language":"CSS","readme":"# mdsync\n\n`mdsync` is like [browsersync](https://github.com/schollz/browsersync), but for markdown.\nIt renders Markdown to HTML and reloads the browser when changes are made.\nBatteries included:\n  - Embedded fonts ([Iosevka](https://github.com/be5invis/Iosevka))\n  - Embedded style (gruvbox like; dark/light)\n  - Embedded [highlight.js](https://highlightjs.org/)\n\n![image alt \u003c\u003e](./docs/dark_light.png)\n\nCSS and scripts for styling and code-highlighting can be extended or replaced.\n\n## Installation\n\n```shell\n\u003e go get -u github.com/rverst/mdsync\n```\n\n## Usage\n\n```shell\n\u003e mdsync example.md\n```\nThis opens the default browser on `http://localhost:5000` to display the rendered output.\n\n```shell\n  Usage:\n    markdown sync [path]\n\n  Positional Variables:\n    path   The markdown file to render\n\n  Flags:\n       --version      Displays the program version string.\n    -h --help         Displays this help.\n    -c --css          A custom css path to style the output.\n    -s --script       A custom script path to manipulate the output.\n    -p --port         The port the server will listen on (default: 5000).\n       --no-browser   Prevents the browser from being opened.\n       --raw          No embedded scripts and styles, custom files will\n                      work though.\n```\n\nWith no arguments provided, the first markdown file in the current directory will be loaded.\n\nWith `--css` and `--script` custom styles or scripts can be loaded. These will be loaded\nafter the embedded [style.css](embedded/www/css/style.css) or [highlight.js](embedded/www/script/highlight.js).\nWith the switch -raw the embedded styles and scripts can be switched off (except for the reload-script).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frverst%2Fmdsync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frverst%2Fmdsync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frverst%2Fmdsync/lists"}