{"id":29698473,"url":"https://github.com/badiwidya/mdserve","last_synced_at":"2026-05-18T11:06:22.604Z","repository":{"id":304794259,"uuid":"1019857645","full_name":"badiwidya/mdserve","owner":"badiwidya","description":"A cross-platform CLI tool to instantly serve and live-preview Markdown files with GitHub styling.","archived":false,"fork":false,"pushed_at":"2026-05-07T13:58:14.000Z","size":26,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-07T15:47:22.423Z","etag":null,"topics":["cli","cross-platform","dev-tool","gfm","go","golang","lightweight","live-reload","markdown","markdown-preview","server"],"latest_commit_sha":null,"homepage":"","language":"Go","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/badiwidya.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-15T01:49:06.000Z","updated_at":"2026-05-07T14:02:02.000Z","dependencies_parsed_at":"2025-07-15T17:20:57.450Z","dependency_job_id":"09357157-f015-44c7-a7a3-230b2b044a33","html_url":"https://github.com/badiwidya/mdserve","commit_stats":null,"previous_names":["badiwidya/serve-markdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/badiwidya/mdserve","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badiwidya%2Fmdserve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badiwidya%2Fmdserve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badiwidya%2Fmdserve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badiwidya%2Fmdserve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badiwidya","download_url":"https://codeload.github.com/badiwidya/mdserve/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badiwidya%2Fmdserve/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33175885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"ssl_error","status_checked_at":"2026-05-18T09:27:28.300Z","response_time":71,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cli","cross-platform","dev-tool","gfm","go","golang","lightweight","live-reload","markdown","markdown-preview","server"],"created_at":"2025-07-23T10:07:49.080Z","updated_at":"2026-05-18T11:06:22.599Z","avatar_url":"https://github.com/badiwidya.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdserve - Serve Markdown\n\nA simple markdown renderer written in Go.\n\n## Features\n\n- Live reloading [\u003csup\u003e\\[1\\]\u003c/sup\u003e](#credits)\n- Github Flavored Markdown (GFM) support [\u003csup\u003e\\[2\\]\u003c/sup\u003e](#credits)\n- Github-like visual [\u003csup\u003e\\[3\\]\u003c/sup\u003e](#credits)\n- Syntax highlighting support [\u003csup\u003e\\[4\\]\u003c/sup\u003e](#credits)\n- Zero configuration\n\nIt renders your Markdown file to the browser, nothing more, nothing less.\n\n## Usage\n\n```bash\n mdserve [-theme=light|dark|auto] [markdown file]\n```\n\nIf no flag is provided, the default is `auto`.\n\nThen open your browser and go to: `http://localhost:6942`\n\n## Installation\n\n### Install using `go install`:\n\n```bash\ngo install github.com/badiwidya/mdserve@latest\n```\n\nMake sure your Go binary path (`$GOPATH/bin`) is included in your system's environment `$PATH`.\n\n1. **Linux/macOs**\n\nAdd the following line to your shell config (`~/.zshrc`, `~/.bashrc`, or anything you use).\n\n```bash\nexport PATH=$PATH:$(go env GOPATH)/bin\n```\n\nThen apply changes by restarting your terminal or running:\n\n```bash\nsource ~/.zshrc\n\n# or\n\nsource ~/.bashrc\n\n# or etc.\n```\n\n2. **Windows**\n\n- Open **Start Menu** and search for `env`, then select **Edit the system environment variables.**\n- In the System Properties window, click **Environment Variables....**\n- Under **System variables** (or User variables), find and select the variable named `Path`, then click **Edit**.\n- Click **New**, then enter:\n\n```\n%USERPROFILE%\\go\\bin\n```\n\n- Click `OK` to save and apply changes.\n- Restart your terminal (e.g., PowerShell, CMD, or Git Bash).\n\n### Manual installation\n\n1. Clone this repository:\n\n```bash\ngit clone https://github.com/badiwidya/mdserve.git\ncd mdserve\n```\n\n2. Build the project:\n\n```bash\ngo build .\n```\n\nThis will generate a `mdserve` (or `mdserve.exe` on Windows) binary in the current directory.\n\n3. (Optional) Move the binary to your `$PATH`\n\nOn **Linux/macOS**:\n\n```bash\nmv mdserve ~/.local/bin\n```\n\nOn **Windows**:\n\n```cmd\nmove mdserve.exe %USERPROFILE%\\bin\n```\n\n\u003e NOTE: Make sure `%USERPROFILE%\\bin` is added to your `PATH`.\n\n## Credits\n\n1. [fsnotify](https://github.com/fsnotify/fsnotify)\n2. [goldmark](https://github.com/yuin/goldmark)\n3. [github-markdown-css](https://github.com/sindresorhus/github-markdown-css)\n4. [chroma](https://github.com/alecthomas/chroma)\n\n## License\n\nSee [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadiwidya%2Fmdserve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadiwidya%2Fmdserve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadiwidya%2Fmdserve/lists"}