{"id":16293428,"url":"https://github.com/alekzonder/mrk","last_synced_at":"2025-03-20T03:31:07.495Z","repository":{"id":57303857,"uuid":"80390691","full_name":"alekzonder/mrk","owner":"alekzonder","description":"simple markdown server","archived":false,"fork":false,"pushed_at":"2023-01-22T07:17:26.000Z","size":429,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T22:55:04.993Z","etag":null,"topics":["markdown","server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/alekzonder.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":"2017-01-30T03:22:00.000Z","updated_at":"2020-01-23T17:13:08.000Z","dependencies_parsed_at":"2023-02-12T15:01:49.161Z","dependency_job_id":null,"html_url":"https://github.com/alekzonder/mrk","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fmrk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fmrk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fmrk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekzonder%2Fmrk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alekzonder","download_url":"https://codeload.github.com/alekzonder/mrk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244047647,"owners_count":20389206,"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"],"created_at":"2024-10-10T20:11:14.668Z","updated_at":"2025-03-20T03:31:07.193Z","avatar_url":"https://github.com/alekzonder.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mrk\n\n[![NPM](https://nodei.co/npm/mrk.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/mrk/)\n\nsimple markdown server\n\ncan render and upload your docs to webdav\n\npowered with [markdown-it](https://github.com/markdown-it/markdown-it)\n\nstyles from [github-markdown-css](https://github.com/sindresorhus/github-markdown-css)\n\nhighlight code with [highlight.js](https://highlightjs.org/)\n\n![img](docs/screenshot.png)\n\n# install\n\n```\nnpm install -g mrk@latest\n```\n\n# usage\n\n## start\n\nalias: s\n\n- start markdown server on 3334 port for all network interfaces\n- watch all .md files in current work directory\n- recompile .md on change\n\nopen in browser http://localhost:3334\n\n```\nmrk\n\n# OR\n\nmrk start\n\n# OR\n\nmrk s\n```\n\n## render [work dir]\n\nalias: r\n\nrender all .md files in current work directory to ./www_md directory\n\n### options\n\n`--footer \u003cfilepath\u003e` - set your custom footer with analytics or js\n`--raw` - render without header and footer\n\n## clean\n\nalias: c\n\nclean all rendered files\n\n## upload \u003cwebdav-url\u003e\n\nalias: up\n\nupload rendered files to webdav\n\n```\nmrk upload http://example.com/docs/\n```\n\n# LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekzonder%2Fmrk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falekzonder%2Fmrk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekzonder%2Fmrk/lists"}