{"id":17380094,"url":"https://github.com/zhaoxingyue/easymd","last_synced_at":"2025-04-15T09:29:58.601Z","repository":{"id":57218910,"uuid":"87999808","full_name":"zhaoxingyue/easymd","owner":"zhaoxingyue","description":"open markdown in browser \u0026\u0026  conversion markdown into html","archived":false,"fork":false,"pushed_at":"2020-04-20T09:57:17.000Z","size":15,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T18:51:48.963Z","etag":null,"topics":["cli","highlight","html","markdown"],"latest_commit_sha":null,"homepage":"https://easymd-test1.now.sh","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/zhaoxingyue.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-04-12T02:16:41.000Z","updated_at":"2020-04-20T09:54:29.000Z","dependencies_parsed_at":"2022-08-29T02:11:49.500Z","dependency_job_id":null,"html_url":"https://github.com/zhaoxingyue/easymd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhaoxingyue%2Feasymd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhaoxingyue%2Feasymd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhaoxingyue%2Feasymd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhaoxingyue%2Feasymd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhaoxingyue","download_url":"https://codeload.github.com/zhaoxingyue/easymd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804803,"owners_count":21164134,"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":["cli","highlight","html","markdown"],"created_at":"2024-10-16T06:21:47.014Z","updated_at":"2025-04-15T09:29:58.583Z","avatar_url":"https://github.com/zhaoxingyue.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EASYMD\n\nA simple cli for open markdown file  \n\n[![Build Status](https://travis-ci.org/zhaoxingyue/easymd.svg?branch=master)](https://travis-ci.org/zhaoxingyue/easymd)\n[![Coverage Status](https://coveralls.io/repos/github/zhaoxingyue/easymd/badge.svg?branch=master)](https://coveralls.io/github/zhaoxingyue/easymd?branch=master)\n[![Join the chat at https://gitter.im/easymd/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/easymd/Lobby?utm_source=share-link\u0026utm_medium=link\u0026utm_campaign=share-link)\n[![Dependency Status](https://dependencyci.com/github/zhaoxingyue/easymd/badge)](https://dependencyci.com/github/zhaoxingyue/easymd)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)  \n\n## Why easymd ?\n\n- Simple cli options\n- Code highlight greate\n\n## Install\n\nRun the following command in Terminal:\n\n```\n$ npm install -g easymd\n```\n**Note**: To run the preceding commands, Node.js and npm must be installed.\n\n## Usage\n\nAfter you've installed easymd, you should be able to use the easymd program.\n\n```\n$ easymd --help\n\n Usage: easymd [options]\n\n  Options:\n\n    -h, --help            output usage information\n    -V, --version         output the version number\n    -f, --file \u003cfile\u003e     create HTML file\n    -b, --browser \u003cfile\u003e  open markdown in browser\n\n  Examples:\n\n    $ easymd -b index.md\n    $ easymd -f index.md /your/html/path/ \n\n```\nThe simplest use case would be opening the markdown file in the browser:\n\n```\n$ easymd -b README.md\n```\nOn browser looks like this:\n\n\u003cimg src=\"http://qiniu.mengxiaoban.cn/customerFiles/20170412180606_admin_browser.png\" style=\"width: 600px;height: 500px\"\u003e\n\nEasymd also can write html file:\n\n```\n$ easymd -f README.md\n```\nor \n```\n$ easymd -f README.md /your/output/path \n```\n\n## Running Tests \u0026 Contributing\n\n```\n$ git clone git@github.com:zhaoxingyue/easymd.git\n$ npm install\n$ npm test\n```\n\nHere are some important packages in the easymd ecosystem:\n\n- [marked](https://github.com/chjj/marked) - a markdown parser and compiler.\n- [highlight.js](https://github.com/isagalaev/highlight.js) - javascript syntax highlighter.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhaoxingyue%2Feasymd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhaoxingyue%2Feasymd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhaoxingyue%2Feasymd/lists"}