{"id":16752808,"url":"https://github.com/aalekhpatel07/ws-markdown-server","last_synced_at":"2026-01-02T14:49:55.517Z","repository":{"id":65251469,"uuid":"589055065","full_name":"aalekhpatel07/ws-markdown-server","owner":"aalekhpatel07","description":"Markdown Websocket (and Unix socket) server","archived":false,"fork":false,"pushed_at":"2023-01-18T07:10:02.000Z","size":77,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T06:48:35.669Z","etag":null,"topics":["markdown-server","markdown-to-html","markdown-webserver","websocket-server"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aalekhpatel07.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2023-01-14T22:46:53.000Z","updated_at":"2023-02-21T04:16:03.000Z","dependencies_parsed_at":"2023-02-10T13:46:19.490Z","dependency_job_id":null,"html_url":"https://github.com/aalekhpatel07/ws-markdown-server","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aalekhpatel07%2Fws-markdown-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aalekhpatel07%2Fws-markdown-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aalekhpatel07%2Fws-markdown-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aalekhpatel07%2Fws-markdown-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aalekhpatel07","download_url":"https://codeload.github.com/aalekhpatel07/ws-markdown-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243827982,"owners_count":20354415,"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":["markdown-server","markdown-to-html","markdown-webserver","websocket-server"],"created_at":"2024-10-13T02:48:10.521Z","updated_at":"2026-01-02T14:49:55.479Z","avatar_url":"https://github.com/aalekhpatel07.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown server\n\nA simple Markdown Websocket (and Unix socket) server backed by [`comrak`](https://docs.rs/comrak/latest/comrak/) and [`tokio-tungstenite`](https://github.com/snapview/tokio-tungstenite).\n\n## Installation and Usage\n\n### Docker (recommended):\n\n1. Download the docker image.\n```sh\ndocker pull aalekhpatel07/ws-markdown-server:1.0.2\n```\n\n2. Start the container:\n\n**Note**: The `9004` tcp port bind is optional and only required if you wish to expose a Unix socket server along with a WebSocket server (which runs on `9003`).\n\n```sh\ndocker run \\\n  -d \\\n  -p 9003:9003 \\\n  -p 9004:9004 \\\n  --name ws-markdown-server \\\n  aalekhpatel07/ws-markdown-server:1.0.0\n```\n\n### Local\n\nYou can run a Markdown server on your local machine via `ws-markdown-server`:\n\n1. Install it with `cargo`:\n```sh\ncargo install ws-markdown-server@1.0.2\n```\n2. Start the server:\n```sh\nRUST_LOG=\"ws_markdown_server=debug\" \\\n    MD_SERVER_WS_PORT=9003 \\\n    MD_SERVER_TCP_PORT=9004 \\\n    MD_SERVER_HOST=\"0.0.0.0\" \\\n    ws-markdown-server\n```\n\n## Testing it works\n\n1. You can test it works by opening a tcp connection at `0.0.0.0:9004` and sending in some markdown text to be converted to html. \nFor example:\n\n```sh\n# Start netcat once the markdown server is up and running.\nnc 0.0.0.0 9004\n  \n# Send some markdown text to be converted to html.\n\n\u003e # Title\n\u003e This is some text.\n\u003e ...\n\u003e [Ctrl+D] (indicates end of file)\n  \n# You'll receive the html version of the sent markdown:\n\n# \u003ch1\u003e Title \u003c/h1\u003e\n# \u003cp\u003eThis is some text.\u003c/p\u003e\n# ...\n```\n\n2. Alternatively, you can also run the sample [`Svelte` app](./usage/client) that sets up the client-side Websocket and uses the `ws-markdown-server` for its backend.\n\n```sh\ncd usage/client\nnpm install\nnpm run dev -- --port 8000 --host 0.0.0.0 --open\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faalekhpatel07%2Fws-markdown-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faalekhpatel07%2Fws-markdown-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faalekhpatel07%2Fws-markdown-server/lists"}