{"id":13852051,"url":"https://github.com/mobily/markdown-live","last_synced_at":"2025-07-13T03:33:08.499Z","repository":{"id":24123048,"uuid":"27511551","full_name":"mobily/markdown-live","owner":"mobily","description":"Markdown preview with live update.","archived":true,"fork":false,"pushed_at":"2016-06-22T03:01:58.000Z","size":2755,"stargazers_count":342,"open_issues_count":7,"forks_count":22,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-06-24T10:09:52.878Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mobily.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-03T22:45:47.000Z","updated_at":"2025-03-06T15:34:45.000Z","dependencies_parsed_at":"2022-08-22T11:01:29.408Z","dependency_job_id":null,"html_url":"https://github.com/mobily/markdown-live","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mobily/markdown-live","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobily%2Fmarkdown-live","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobily%2Fmarkdown-live/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobily%2Fmarkdown-live/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobily%2Fmarkdown-live/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mobily","download_url":"https://codeload.github.com/mobily/markdown-live/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobily%2Fmarkdown-live/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265083934,"owners_count":23708834,"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":[],"created_at":"2024-08-04T22:00:56.126Z","updated_at":"2025-07-13T03:33:07.936Z","avatar_url":"https://github.com/mobily.png","language":"JavaScript","readme":"# markdown-live\n\n\u003e Markdown preview with live update.\n\n## Contents\n\n* [Screencasts](#screencasts)\n* [Installation](#installation)\n* [Usage](#usage)\n* [CLI](#cli)\n* [Contributions](#contributions)\n* [Contact](#contact)\n* [Changelog](#changelog)\n* [License](#license)\n\n## Screencasts\n\n![](https://raw.githubusercontent.com/mobily/markdown-live/master/screencasts/gif1.gif)\n\n![](https://raw.githubusercontent.com/mobily/markdown-live/master/screencasts/gif2.gif)\n\n## Installation\n\n```shell\n$ npm install -g markdown-live\n```\n\n## Usage\n\nTo list all available options:\n\n```shell\n$ mdlive --help\n```\n\nTo run with custom port and directory:\n\n```shell\n$ mdlive --port 1024 --dir [PATH]\n```\n\nTo watch markdown files outside the current directory:\n\n```shell\n$ mdlive --file [, FILE]\n```\n\nTo set another socket.io hostname:\n\n```shell\n$ mdlive --socket \"http://127.0.0.1:8080\"\n```\n\n## CLI\n\n```shell\nUSAGE: mdlive [OPTIONS]\n\nOPTIONS:\n\n  -h, --help         Show this message and exit.\n  -d, --dir          Specifies the directory to find markdown files (default: current directory).\n  -f, --file         Specifies markdown files to watch.\n  -p, --port         Specifies the port to use (default: 2304).\n  -v, --verbose      Provides debug messages.\n  -s, --socket       Specifies the socket.io hostname or IP address (default: http://localhost)\n```\n\n```shell\nAVAILABLE MARKDOWN EXTENSIONS:\n  \n  *.markdown\n  *.mdown\n  *.mkdn\n  *.md\n  *.mkd\n  *.mdwn\n  *.mdtxt\n  *.mdtext\n```\n\n## Contributions\n\n - Fork repository\n - Create feature- or bugfix-branch\n - Create pull request\n - Use Github Issues\n\n## Contact\n\n - Marcin Dziewulski, \u003chello@mobily.pl\u003e\n - Twitter: [@marcinmobily](https://twitter.com/marcinmobily)\n\n## Changelog\n\n```\n2015-01-17    1.0.8    added support for alternate filename extensions\n                       added support for setting socket.io hostname  or IP address\n2014-12-09    1.0.6    watch *.md files outside the current directory (option: --file)\n2014-12-08    1.0.5    better code highlighting\n2014-12-03    1.0.0    initial version\n```\n\n## License\n\n\tThe MIT License (MIT)\n\n\tCopyright (c) 2014 Marcin Dziewulski\n\n\tPermission is hereby granted, free of charge, to any person obtaining a copy\n\tof this software and associated documentation files (the \"Software\"), to deal\n\tin the Software without restriction, including without limitation the rights\n\tto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n\tcopies of the Software, and to permit persons to whom the Software is\n\tfurnished to do so, subject to the following conditions:\n\n\tThe above copyright notice and this permission notice shall be included in all\n\tcopies or substantial portions of the Software.\n\n\tTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n\tIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n\tFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n\tAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n\tLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n\tOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n\tSOFTWARE.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobily%2Fmarkdown-live","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmobily%2Fmarkdown-live","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobily%2Fmarkdown-live/lists"}